finalized: added comments, TODOs, and suggestions for future devs working in the testing suites

esclarsky · esclarsky · commit 425d0789305e · 2022-05-18T12:00:11.000-04:00
diff --git a/__tests__/composerTests.js b/__tests__/composerTests.js
@@ -2,7 +2,7 @@
 import React from 'react';
 import ProtocolSelect from '../src/client/components/composer/NewRequest/ProtocolSelect.jsx';
 
-// Commented out this file since it is using Enzyme, which has been falling out of favor
+// Commented out this file since it is using Enzyme, which has been falling out of favor and currently does not work for this app version
 // TODO: for the next tester, recommended to migrate to React Testing Library
 
 // import { configure, shallow } from 'enzyme';
diff --git a/__tests__/httpTest.js b/__tests__/httpTest.js
@@ -1,5 +1,10 @@
 import ReqResCtrl from '../src/client/controllers/reqResController';
 
+// TODO: Integration tests with the actual API. The controller calls api.send and api.recieve
+// without attachement to the API, the tests in this file don't perform anything.
+// Additionally, add a testing file for graphQLController. This is currently untested
+// and is a dependency for reqResController.
+
 describe('REST API Requests', () => {
   let state;
   beforeEach(() => {
@@ -104,9 +109,13 @@ describe('REST API Requests', () => {
         tab: 'First Tab',
       };
 
-      ReqResCtrl.openReqRes(request);
+      state = ReqResCtrl.openReqRes(request);
       const response = state.reqResArray[0];
       expect(response.toEqual('hello'));
     });
+
+    it('should toggle select all',()=>{
+      expect(ReqResCtrl.toggleSelectAll()).not.toThrowError;
+    })
   });
 });
diff --git a/__tests__/openAPIParserTest.js b/__tests__/openAPIParserTest.js
@@ -0,0 +1,20 @@
+const fs = require('fs');
+const path = require('path');
+
+import openapiParserFunc from '../main_process/openapiParser'
+
+// TODO: Test actual contents of the parser
+
+describe('openAPI Parser tests',()=>{
+  const file = fs.readFileSync(path.resolve(__dirname + '/../test/openAPITestDefinition.yaml'))
+
+  it('should be able to parse a yaml file',()=>{
+    const { openapiMetadata, openapiReqArray } = openapiParserFunc(String(file))
+    expect(openapiMetadata).toBeDefined();
+    expect(openapiReqArray).toBeDefined();
+  })
+
+  it('should error on undefined input',()=>{
+    expect(openapiParserFunc(null)).toThrow(ReferenceError);
+  })
+});
diff --git a/test/openAPITestDefinition.yaml b/test/openAPITestDefinition.yaml
@@ -0,0 +1,44 @@
+openapi: 3.0.0
+info:
+  title: Sample API
+  description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
+  version: 0.1.9
+servers:
+  - url: http://api.example.com/v1
+    description: Optional server description, e.g. Main (production) server
+  - url: http://staging-api.example.com
+    description: Optional server description, e.g. Internal staging server for testing
+paths:
+  /users/{userId}:
+    get:
+      summary: Returns a user by ID.
+      parameters:
+        - name: userId
+          in: path
+          required: true
+          description: The ID of the user to return.
+          schema:
+            type: integer
+            format: int64
+            minimum: 1
+      responses:
+        '200':
+          description: A user object.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  id:
+                    type: integer
+                    format: int64
+                    example: 4
+                  name:
+                    type: string
+                    example: Jessica Smith
+        '400':
+          description: The specified user ID is invalid (not a number).
+        '404':
+          description: A user with the specified ID was not found.
+        default:
+          description: Unexpected error
diff --git a/test/subSuites/appOpens.js b/test/subSuites/appOpens.js
@@ -1,3 +1,6 @@
+// Test to see if the Electron application opens and runs properly, with proper windows and 
+// major component names
+
 const fs = require('fs-extra');
 const {_electron: electron} = require('playwright');
 const pwTest = require('@playwright/test');
diff --git a/test/subSuites/graphqlTest.js b/test/subSuites/graphqlTest.js
@@ -1,3 +1,8 @@
+// Test GraphQL protocol by introspecting and querying both public and local GraphQL APIs
+// TODO: possibly remove our own server from this testing suite and go with a public API.
+// Tests may fail due to the user's computer and this testing suite becomes heavier 
+// with a mock server. 
+
 const graphqlServer = require('../graphqlServer');
 const {_electron: electron} = require('playwright');
 const chai = require('chai')
diff --git a/test/subSuites/graphqlTestingTest.js b/test/subSuites/graphqlTestingTest.js
@@ -1,3 +1,5 @@
+// Confirm testing of request/response works for GraphQL
+
 const graphqlServer = require('../graphqlServer');
 const {_electron: electron} = require('playwright');
 const chai = require('chai')
@@ -126,9 +128,6 @@ module.exports = () => {
         const scriptBody = await codeMirror2.locator('.cm-content');
 
         try {
-          // for (let i = 0; i < 100; i += 1) {
-          //   await scriptBody.press('Backspace');
-          // }
           scriptBody.fill('')
           await scriptBody.fill(script);
         } catch (err) {
diff --git a/test/subSuites/grpcTest.js b/test/subSuites/grpcTest.js
@@ -1,3 +1,8 @@
+// gRPC tests using "hw2.proto" file to set up gRPC in grpcServer
+// TODO: possibly remove our own server from this testing suite and go with a public API.
+// Tests may fail due to the user's computer and this testing suite becomes heavier 
+// with a mock server. 
+
 const grpcServer = require('../grpcServer.js');
 const graphqlServer = require('../graphqlServer');
 const {_electron: electron} = require('playwright');
diff --git a/test/subSuites/grpcTestingTest.js b/test/subSuites/grpcTestingTest.js
@@ -1,3 +1,5 @@
+// Confirm testing of request/response works for grpc
+
 const grpcServer = require('../grpcServer.js');
 const {_electron: electron} = require('playwright');
 const chai = require('chai')
@@ -113,9 +115,6 @@ module.exports = () => {
         const scriptBody = await codeMirror2.locator('.cm-content');
 
         try {
-          // for (let i = 0; i < 100; i += 1) {
-          //   await scriptBody.press('Backspace');
-          // }
           scriptBody.fill('')
           await scriptBody.fill(script);
         } catch (err) {
diff --git a/test/subSuites/httpTest.js b/test/subSuites/httpTest.js
@@ -1,3 +1,9 @@
+// http tests using local server and public API
+// TODO: Please note, this is only testing HTTP currently. HTTP2 testing is non-existent and should be added 
+// TODO: possibly remove our own server from this testing suite and go with a public API.
+// Tests may fail due to the user's computer and this testing suite becomes heavier 
+// with a mock server. 
+
 const {_electron: electron} = require('playwright');
 const chai = require('chai')
 const expect = chai.expect
@@ -83,14 +89,8 @@ module.exports = () => {
           const restBody = await codeMirror.locator('.cm-content');
 
           try {
-            // for (let i = 0; i < 100; i += 1) {
-            //   await restBody.press('Backspace');
-            // }
             restBody.fill('')
             await restBody.fill(body);
-            // for (let i = 0; i < 6; i += 1) {
-            //   await restBody.press('Delete');
-            // }
           } catch (err) {
             console.error(err);
           }
diff --git a/test/subSuites/httpTestingTest.js b/test/subSuites/httpTestingTest.js
@@ -1,3 +1,5 @@
+// Confirm testing of request/response works for REST
+
 const {_electron: electron} = require('playwright');
 const chai = require('chai')
 const expect = chai.expect
@@ -86,9 +88,6 @@ module.exports = () => {
           const restBody = await codeMirror.locator('.cm-content');
 
           try {
-            // for (let i = 0; i < 100; i += 1) {
-            //   await restBody.press('Backspace');
-            // }
             await restBody.fill('');
             await restBody.fill(body);
           } catch (err) {
@@ -120,9 +119,6 @@ module.exports = () => {
         const scriptBody = await codeMirror2.locator('.cm-content');
 
         try {
-          // for (let i = 0; i < 100; i += 1) {
-          //   await scriptBody.press('Backspace');
-          // }
           await scriptBody.fill('');
           await scriptBody.fill(script);
         } catch (err) {
diff --git a/test/subSuites/openAPITest.js b/test/subSuites/openAPITest.js
@@ -0,0 +1,54 @@
+// openAPI tests using openAPITestDefinition.yaml
+// TODO: Test suite incomplete, currently only testing if the Load Document button appears
+// Testing should be added to confirm openAPI works using the provided YAML
+
+
+const {_electron: electron} = require('playwright');
+const chai = require('chai')
+const expect = chai.expect
+const path = require('path');
+const fs = require('fs');
+
+let electronApp, page;
+
+module.exports = () => {
+
+  const setupFxn = function() {
+    before(async () => {
+      electronApp = await electron.launch({ args: ['main.js'] });
+      page = electronApp.windows()[0]; // In case there is more than one window
+      await page.waitForLoadState(`domcontentloaded`);
+
+      await page.locator('text=OPENAPI').click();
+
+    });
+    
+    // close Electron app when complete
+    after(async () => {
+      await electronApp.close();
+
+      try {
+      } catch (err) {
+        console.error(err);
+      }
+
+    });
+
+    afterEach(async function() {
+      if (this.currentTest.state === 'failed') {
+        console.log(`Screenshotting failed test window`)
+        const imageBuffer = await page.screenshot();
+        fs.writeFileSync(path.resolve(__dirname + '/../failedTests', `FAILED_${this.currentTest.title}.png`), imageBuffer)
+      }
+    });
+  }
+
+  describe('openAPI testing', () => {
+    setupFxn();
+
+    it('it should have a "Load Document" button', async () => {
+      const handle = await page.locator('text=Load Document');
+      expect(handle.count()).to.equal(1);
+    });
+}).timeout(20000)
+};
diff --git a/test/subSuites/reqInputTests.js b/test/subSuites/reqInputTests.js
@@ -1,3 +1,6 @@
+// Testing UI that all protocol and request types are represented, parameters can be entered,
+// and panels appear appropriately in the application 
+
 const {_electron: electron} = require('playwright');
 const chai = require('chai')
 const expect = chai.expect
diff --git a/test/subSuites/webRTCTest.js b/test/subSuites/webRTCTest.js
@@ -1,3 +1,8 @@
+// webRTC test using public server. Currently very thin, only confirms that a server
+// can be added to the workspace
+// TODO: Properly test webRTC protocol. Please note the webRTC protocol is very broken and unsure if it
+// even currently works for any functionality purposes.
+
 const {_electron: electron} = require('playwright');
 const chai = require('chai')
 const expect = chai.expect
@@ -55,9 +60,6 @@ module.exports = () => {
         const webRTCServer = await codeMirror.locator('.cm-content');
 
         try {
-          // for (let i = 0; i < 100; i += 1) {
-          //   await webRTCServer.press('Backspace');
-          // }
           await webRTCServer.fill('');
           await webRTCServer.fill(server);
         } catch (err) {
diff --git a/test/subSuites/websocketTest.js b/test/subSuites/websocketTest.js
@@ -1,4 +1,9 @@
 /* eslint-disable no-async-promise-executor */
+// Testing websocket requests using websocketserver.js
+// TODO: possibly remove our own server from this testing suite and go with a public API.
+// Tests may fail due to the user's computer and this testing suite becomes heavier 
+// with a mock WS server. 
+
 const {_electron: electron} = require('playwright');
 const chai = require('chai')
 const expect = chai.expect;
diff --git a/test/testSuite.js b/test/testSuite.js
@@ -1,13 +1,30 @@
 // End-to-end testing on the electron app using Playwright
 // ****** use "npm run test-mocha" or "npm run test" to run these tests ******
 
+// This testing suite uses Playwright to launch an instance of the Electron application.
+// Each test is in the suite below is run with a separate instance of Electron, this is what
+// setupFxn() in each of the files is. It will set up Electron, and also set up functionality
+// to screenshot the window on a failed test.
+// Please note many of these tests are written contingent on each other, and there is room for 
+// better optimization of end-to-end testing. 
+
+// TODO: openAPI testing and webRTC testing is extremely thin, essentially non-existent. Webhook
+// testing needs to be added
+// TODO: Much of the UI is untested, recommended to add testing suites either here or in the 
+// Jest suite to confirm UI rendering. i.e. "View Response History" is untested, populating
+// the composer from workspaces is untested, response cookies and headers are untested. These may
+// be added in end-to-end testing for confirmation of functionality, and in integration testing
+// for confirmation of proper rendering and usage.
+
+
 // Import various tests
 const appOpensTests = require('./subSuites/appOpens');
 const reqInputTests = require('./subSuites/reqInputTests');
 const httpTest = require('./subSuites/httpTest');
 const websocketTest = require('./subSuites/websocketTest');
 const grpcTest = require('./subSuites/grpcTest');
 const graphqlTest = require('./subSuites/graphqlTest');
+const openAPITest = require('./subSuites/openAPITest');
 const httpTestingTest = require('./subSuites/httpTestingTest');
 const graphqlTestingTest = require('./subSuites/graphqlTestingTest');
 const grpcTestingTest = require('./subSuites/grpcTestingTest');
@@ -26,16 +43,17 @@ describe('Electron UI Rendering', function () {
   appOpensTests();
 }).timeout(20000);
 
-describe('CRUD functionality', function () {
+describe('Protocol selection and usage', function () {
   reqInputTests(); 
   httpTest();
   graphqlTest();
   websocketTest();
   grpcTest();
   webRTCTest();
+  openAPITest();
 }).timeout(20000);
 
-describe("Swell Testing functionality", function () {
+describe("Request/response testing functionality", function () {
   httpTestingTest();
   grpcTestingTest();
   graphqlTestingTest();
