Set up e2e tests for scala3doc

Author: grzegorz-bielski

scala3doc/e2e/.prettierrc

@@ -0,0 +1,9 @@
+{
+  "printWidth": 100,
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "arrowParens": "avoid"
+}

scala3doc/e2e/README.md

@@ -0,0 +1,12 @@
+## scala3doc e2e test suite
+
+### Prerequisites
+
+- install Node.js
+- run `npm i`
+
+### Running tests
+
+- generate the test docs: `sbt scala3doc/generateTestcasesDocumentation`
+- run the web server in the `output` directory: `python3 -m http.server 8080`
+- run `npm run cypress:open` to see the cypress UI or `npm run cypress:run` to run tests heedlessly

scala3doc/e2e/cypress.json

@@ -0,0 +1 @@
+{}

scala3doc/e2e/cypress/integration/filter-bar.spec.ts

@@ -0,0 +1,60 @@
+describe('filter-bar', () => {
+  beforeEach(() => cy.visit('http://localhost:8080/testcases/api/tests/-filter-test/index.html'));
+
+  it('properly renders filters extracted from the document', () => {
+    const filterBar = new FilterBarFixture().toggle();
+
+    const testTable = [
+      ['Visibility', ['public', 'protected']],
+      ['Keywords', ['no keywords', 'abstract', 'case', 'final', 'sealed']],
+      ['Extension', ['Standard member', 'from tests']],
+    ];
+
+    testTable.forEach(([title, filterOptions], index) => {
+      const group = filterBar.group(index);
+
+      group.title.should('have.text', title);
+      group.filterOptions.should('deep.equal', filterOptions);
+    });
+  });
+
+  it('filters by && across groups', () => {});
+});
+
+class FilterBarFixture {
+  private get toggleButton() {
+    return cy.findByTestId('filterToggleButton');
+  }
+
+  group(at: number) {
+    return new FilterBarGroupFixture(at);
+  }
+
+  toggle() {
+    this.toggleButton.click();
+
+    return this;
+  }
+}
+
+class FilterBarGroupFixture {
+  constructor(private readonly index: number) {}
+
+  private get group() {
+    return cy.findAllByTestId('filterGroup').eq(this.index);
+  }
+
+  private get filterList() {
+    return this.group.findByTestId('filterGroupList');
+  }
+
+  get title() {
+    return this.group.findByTestId('filterGroupTitle');
+  }
+
+  get filterOptions() {
+    return this.filterList
+      .findAllByTestId('filterGroupButton')
+      .then($buttons => cy.wrap($buttons.toArray().map(i => i.innerText)));
+  }
+}

scala3doc/e2e/cypress/support/commands.ts

@@ -0,0 +1 @@
+import "@testing-library/cypress/add-commands";

scala3doc/e2e/cypress/support/index.ts

@@ -0,0 +1,4 @@
+import './commands';
+import { configure } from '@testing-library/cypress';
+
+configure({ testIdAttribute: 'data-test-id' });