superuser.app 0.0.0

package/src/init/test/run.js

@@ -0,0 +1,45 @@
+import InstantAPI from '@instant.dev/api';
+import dotenv from 'dotenv';
+
+const Gateway = InstantAPI.Gateway;
+const TestEngine = InstantAPI.TestEngine;
+const PORT = 7357; // Leetspeak for "TEST"; can be anything
+
+// (1) Load environment variables; make sure NODE_ENV is "test"
+dotenv.config({path: `.env.test`});
+process.env.NODE_ENV = `test`;
+
+// (2) Initialize and load tests; set PORT for request mocking
+const testEngine = new TestEngine(PORT);
+await testEngine.initialize('./test/tests');
+
+// (3) Setup; create objects and infrastructure for tests
+// Arguments returned here will be sent to .finish()
+await testEngine.setup(async () => {
+
+  console.log();
+  console.log(`# Starting test gateway on localhost:${PORT} ... `);
+  console.log();
+
+  // Start Gateway; {debug: true} will print logs
+  const gateway = new Gateway({debug: false});
+  gateway.load(process.cwd());       // load routes from filesystem
+  gateway.listen(PORT);              // start server
+
+  return { gateway };
+
+});
+
+// (4) Run tests; use first argument to specify a test
+const args = process.argv.slice(3);
+if (args[0]) {
+  await testEngine.run(args[0]);
+} else {
+  await testEngine.runAll();
+}
+
+// (5) Finish; close Gateway
+// Receive arguments from .setup()
+testEngine.finish(async ({ gateway }) => {
+  gateway.close();
+});

package/src/init/test/tests/_index.js

@@ -0,0 +1,53 @@
+const chai = await import('chai');
+const expect = chai.expect;
+
+// Defaults to the filename if no name exported
+export const name = `Main Tests`;
+
+/**
+ * Main Tests
+ * You can pass in as many arguments as you would like in `test/run.js`
+ * @param {any} setupResult Result of the function passed to `.setup()` in `test/run.js`
+ */
+export default async function (setupResult) {
+
+  before(async () => {
+
+    // Set up anything you want executed before your test in this file
+
+  });
+
+  it('Loads a startup page', async () => {
+
+    const testUsername = `test user`;
+
+    // TestEngine can make HTTP requests easily via:
+    //   this.get(path, queryParams, headers);
+    //   this.post(path, bodyParams, headers);
+    //   this.put(path, bodyParams, headers);
+    //   this.del(path, queryParams, headers);
+
+    // Note that Instant API merges queryParams and bodyParams,
+    //   you should never need to test with both
+
+    let result = await this.get(`/`, {username: testUsername});
+
+    expect(result).to.exist;
+    expect(result.statusCode).to.equal(200);
+    expect(result.headers).to.exist;
+    expect(result.headers['x-instant-api']).to.equal('true');
+    expect(result.headers['content-type']).to.equal('application/json');
+    expect(result.body).to.exist;
+    expect(result.json).to.exist; // will exist on application/json responses
+    expect(result.json.message).to.exist;
+    expect(result.json.message).to.equal(`Welcome to Superuser, ${testUsername}!`);
+
+  });
+
+  after(async () => {
+
+    // Tear down and clean up from tests
+
+  });
+
+};

package/src/test/blank.mjs

@@ -0,0 +1,16 @@
+const chai = await import('chai');
+const expect = chai.expect;
+
+/**
+ * Name test
+ * @param {any} setupResult Result of the function passed to `.setup()` in `test/run.js`
+ */
+export default async function (setupResult) {
+
+  it('Runs a test', async () => {
+
+    expect(true).to.equal(true);
+
+  });
+
+};

package/src/test/endpoint.mjs

@@ -0,0 +1,20 @@
+const chai = await import('chai');
+const expect = chai.expect;
+
+export const name = `Endpoint tests: Pathname`;
+/**
+ * Endpoint tests: Pathname
+ * @param {any} setupResult Result of the function passed to `.setup()` in `test/run.js`
+ */
+export default async function (setupResult) {
+
+  // Method Begin
+  it('Responds to HTTP Method', async () => {
+
+    let result = await this.__method__('Pathname', {});
+
+    expect(result.json).to.exist;
+
+  }); // Method End
+
+};