test-ipfs-example

A test suite for testing examples using playwright for browsers and simple output matching for node

Install

1$ npm i test-ipfs-example

Browser <script> tag

Loading this module through a script tag will make it's exports available as TestIpfsExample in the global namespace.

1<script src="https://unpkg.com/test-ipfs-example/dist/index.min.js"></script>

Table of contents

• Install
• Usage
  • Node.js tests
  • Browser tests
• API Docs
• License
• Contribution

Usage

Node.js tests

To run node js tests, create a test file similar to:

1import { waitForOutput } from 'test-ipfs-example/node'
2
3await waitForOutput('the output to expect', 'path/to/example.js')

Run it from your package.json

1{
2  "scripts": {
3    "test": "test-node-example ./my-test.spec.js"
4  }
5}

Browser tests

To run browser tests, create a test file similar to:

1import { setup, expect } from 'test-ipfs-example/browser'
2
3const test = setup({
4  // optionally configure server(s) - if omitted one will be created listening
5  // on a random high port that serves the contents of the `dist` folder in
6  // the root of the example
7  servers: [{
8    port: 0,
9    host: '127.0.0.1',
10    path: 'dist'
11  }]
12})
13
14test.describe('test a browser app', () => {
15  test.beforeEach(async ({ servers, page }) => {
16    await page.goto(servers[0].url)
17  })
18
19  test('should have browser success', async ({ page }) => {
20    // make some playwright assertions here
21    await page.waitForSelector('#app')
22    const connections = await page.textContent('#app')
23    expect(connections).toContain('hello world')
24  })
25})

Run it from your package.json

1{
2  "scripts": {
3    "test": "test-browser-example ./my-test.spec.js"
4  }
5}

API Docs

• https://ipfs-examples.github.io/test-ipfs-example

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.