Documentation issues

[msteller-connyun]

Showroom seems to be very usefull for web components, but the documentation needs to be improved.

Your puppeteer integration example didn’t work for me, but I found this blog

https://medium.com/@eavichay/easy-unit-tests-for-your-web-components-e26bf88483a9

which is using require('showroom/puppeteer')(). But showroom/puppeteer isn’t mentioned in your docu.

trigger() is also not documented, which allows us to call the showroom functions from our config.

Some documentation for find() would would be also useful.

My current test looks with puppeteer and jest looks like this:

const showroom = require('showroom/puppeteer')();

describe('My awesome Test Suite', async () => {

  beforeAll(async () => {
    await showroom.start();
  });

  beforeEach(async () => {
    await showroom.utils.setTestSubject('calendar-graph');
  });

  afterAll(async ()=>{
    await showroom.stop();
  });

  test('Awesome component test', async () => {
    await showroom.utils.trigger('initStatusMapping');
    await showroom.utils.trigger('initData');
    const foo = await (await showroom.utils.find('//*')).getProperty('innerHTML');

    expect(foo._remoteObject.value).toBe('test');

  });
});

For some reason getProperty() returns an Object instead of the string directly.