refactor into test-engine

mnot · mnot · commit b10bc095b86c · 2023-07-11T15:32:57.000+10:00
diff --git a/index.html b/index.html
@@ -10,14 +10,14 @@
     <meta property="og:url" content="https://cache-tests.fyi/">
     <meta property="og:site_name" content="HTTP Caching Tests">
     <meta property="og:image" content="https://cache-tests.fyi/asset/badge.png">
-    <link rel="preload" as="fetch" crossorigin href="/lib/tpl/explain-test.liquid">
-    <link rel="preload" as="fetch" crossorigin href="/lib/tpl/checks.liquid">
-    <link rel="preload" as="fetch" crossorigin href="/lib/tpl/header-list.liquid">
-    <link rel="preload" as="fetch" crossorigin href="/lib/tpl/header-magic.liquid">
+    <link rel="preload" as="fetch" crossorigin href="/test-engine/lib/tpl/explain-test.liquid">
+    <link rel="preload" as="fetch" crossorigin href="/test-engine/lib/tpl/checks.liquid">
+    <link rel="preload" as="fetch" crossorigin href="/test-engine/lib/tpl/header-list.liquid">
+    <link rel="preload" as="fetch" crossorigin href="/test-engine/lib/tpl/header-magic.liquid">
     <script type="module">
       import index from './results/index.mjs'
-      import * as summary from './lib/summary.mjs'
-      import * as display from './lib/display.mjs'
+      import * as summary from './test-engine/lib/summary.mjs'
+      import * as display from './test-engine/lib/display.mjs'
       import baseTests from './tests/index.mjs'
       import surrogate from './tests/surrogate-control.mjs'
 
diff --git a/package.json b/package.json
@@ -16,12 +16,12 @@
     "npm": "^6.14.11"
   },
   "scripts": {
-    "server": "node server/server.mjs",
-    "cli": "node --no-warnings cli.mjs",
-    "export": "node --no-warnings export.mjs",
-    "validate": "node --no-warnings export.mjs validate",
-    "lint": "standard *.mjs client/*.mjs server/*.mjs lib/*.mjs tests/*.mjs spec/*.mjs",
-    "fix": "standard --fix *.mjs client/*.mjs server/*.mjs lib/*.mjs tests/*.mjs spec/*.mjs"
+    "server": "node test-engine/server/server.mjs",
+    "cli": "node --no-warnings test-engine/cli.mjs",
+    "export": "node --no-warnings test-engine/export.mjs",
+    "validate": "node --no-warnings test-engine/export.mjs validate",
+    "lint": "standard test-engine tests spec",
+    "fix": "standard --fix test-engine tests spec"
   },
   "config": {
     "protocol": "http",
@@ -37,6 +37,6 @@
   "devDependencies": {
     "ajv": "^6.12.5",
     "font-awesome": "^4.7.0",
-    "standard": "^14.3.4"
+    "standard": "^17.1.0"
   }
 }
diff --git a/test-browser.html b/test-browser.html
@@ -5,9 +5,9 @@
     <title>Browser HTTP Caching Tests</title>
     <link rel="stylesheet" href="style.css" type="text/css">
     <script type="module">
-      import { runTests, getResults } from './client/runner.mjs'
-      import { testUUIDs } from './client/test.mjs'
-      import * as display from './lib/display.mjs'
+      import { runTests, getResults } from './test-engine/client/runner.mjs'
+      import { testUUIDs } from './test-engine/client/test.mjs'
+      import * as display from './test-engine/lib/display.mjs'
       import baseTests from './tests/index.mjs'
 
       runTests(baseTests, fetch, true)
diff --git a/test-engine/cli.mjs b/test-engine/cli.mjs
@@ -2,8 +2,8 @@ import { runTests, getResults } from './client/runner.mjs'
 import * as display from './lib/display.mjs'
 import { GREEN, NC } from './lib/defines.mjs'
 import fetch from 'node-fetch-with-proxy'
-import tests from './tests/index.mjs'
-import surrogate from './tests/surrogate-control.mjs'
+import tests from '../tests/index.mjs'
+import surrogate from '../tests/surrogate-control.mjs'
 
 tests.push(surrogate)
 
diff --git a/test-engine/client/config.mjs b/test-engine/client/config.mjs
@@ -1,4 +1,3 @@
-
 export let fetch = null
 export let useBrowserCache = false
 export let baseUrl = ''
diff --git a/test-engine/client/fetching.mjs b/test-engine/client/fetching.mjs
@@ -1,4 +1,3 @@
-
 import * as config from './config.mjs'
 import { fixupHeader } from '../lib/header-fixup.mjs'
 
diff --git a/test-engine/client/runner.mjs b/test-engine/client/runner.mjs
@@ -1,4 +1,3 @@
-
 import * as config from './config.mjs'
 import { makeTest, testResults } from './test.mjs'
 
diff --git a/test-engine/client/test.mjs b/test-engine/client/test.mjs
@@ -1,4 +1,3 @@
-
 import * as defines from '../lib/defines.mjs'
 import { fixupHeader } from '../lib/header-fixup.mjs'
 import * as utils from '../lib/utils.mjs'
diff --git a/test-engine/client/utils.mjs b/test-engine/client/utils.mjs
@@ -1,4 +1,3 @@
-
 import * as config from './config.mjs'
 import * as utils from '../lib/utils.mjs'
 import * as defines from '../lib/defines.mjs'
diff --git a/test-engine/export.mjs b/test-engine/export.mjs
@@ -2,14 +2,14 @@ import fs from 'fs'
 
 import Ajv from 'ajv'
 
-import tests from './tests/index.mjs'
-import surrogate from './tests/surrogate-control.mjs'
+import tests from '../tests/index.mjs'
+import surrogate from '../tests/surrogate-control.mjs'
 
 tests.push(surrogate)
 
 if (process.argv[2] === 'validate') {
   const ajv = new Ajv()
-  const schema = JSON.parse(fs.readFileSync('lib/testsuite-schema.json', 'utf8'))
+  const schema = JSON.parse(fs.readFileSync('test-engine/lib/testsuite-schema.json', 'utf8'))
   const validate = ajv.compile(schema)
   const valid = validate(tests)
   if (!valid) {
diff --git a/test-engine/lib/defines.mjs b/test-engine/lib/defines.mjs
@@ -1,4 +1,3 @@
-
 export const noBodyStatus = new Set([204, 304])
 
 export const dateHeaders = new Set(['date', 'expires', 'last-modified', 'if-modified-since', 'if-unmodified-since'])
diff --git a/test-engine/lib/display.mjs b/test-engine/lib/display.mjs
@@ -1,7 +1,7 @@
 /* global Blob marked */
 
-import '../asset/marked.min.js'
-import { Liquid } from '../asset/liquid.browser.esm.mjs'
+import '../../asset/marked.min.js'
+import { Liquid } from '../../asset/liquid.browser.esm.mjs'
 import { modalOpen } from './modal.mjs'
 
 const templateEngine = new Liquid({ root: 'lib/tpl', extname: '.liquid', cache: true })
@@ -113,7 +113,7 @@ export function showTestResult (testSuites, testId, testResults) {
 
 export function showTestDetails (test) {
   templateEngine
-    .renderFile('explain-test', { test: test })
+    .renderFile('explain-test', { test })
     .then(result => {
       console.log(result)
       const html = marked.parse(result)
diff --git a/test-engine/lib/header-fixup.mjs b/test-engine/lib/header-fixup.mjs
@@ -1,4 +1,3 @@
-
 import { locationHeaders, dateHeaders } from './defines.mjs'
 import { httpDate } from './utils.mjs'
 
diff --git a/test-engine/lib/modal.mjs b/test-engine/lib/modal.mjs
@@ -1,4 +1,3 @@
-
 export function modalOpen (content) {
   let modal = document.getElementById('modal')
   if (!modal) {
diff --git a/test-engine/lib/summary.mjs b/test-engine/lib/summary.mjs
@@ -1,6 +1,6 @@
 /* global fetch marked */
 
-import '../asset/marked.min.js'
+import '../../asset/marked.min.js'
 import * as display from './display.mjs'
 
 export function loadResults (index) {
diff --git a/test-engine/lib/utils.mjs b/test-engine/lib/utils.mjs
@@ -1,4 +1,3 @@
-
 export function AssertionError (options) {
   this.name = 'Assertion'
   this.message = options.message
@@ -12,30 +11,9 @@ export function SetupError (options) {
 export function assert (isSetup, expr, message) {
   if (expr) return
   if (isSetup) {
-    throw new SetupError({ message: message })
+    throw new SetupError({ message })
   } else {
-    throw new AssertionError({ message: message })
-  }
-}
-
-const contentSeed = 1
-const contentStore = {}
-export function httpContent (csKey, contentLength = 15) {
-  if (csKey in contentStore) {
-    return contentStore[csKey]
-  } else {
-    let keySeed = 0
-    for (let i = 0; i < csKey.length; i++) {
-      keySeed += csKey.charCodeAt(i)
-    }
-    const contents = []
-    for (let i = 0; i < contentLength; ++i) {
-      const idx = ((i * keySeed * contentSeed) % 26) + 97
-      contents.push(String.fromCharCode(idx))
-    }
-    const content = contents.join('')
-    contentStore[csKey] = content
-    return content
+    throw new AssertionError({ message })
   }
 }
 
diff --git a/test-engine/server/handle-config.mjs b/test-engine/server/handle-config.mjs
@@ -1,4 +1,3 @@
-
 import { sendResponse, configs, setConfig } from './utils.mjs'
 
 export default function handleConfig (pathSegs, request, response) {
diff --git a/test-engine/server/handle-file.mjs b/test-engine/server/handle-file.mjs
@@ -1,4 +1,3 @@
-
 import fs from 'fs'
 import path from 'path'
 import process from 'process'
diff --git a/test-engine/server/handle-state.mjs b/test-engine/server/handle-state.mjs
@@ -1,4 +1,3 @@
-
 import { sendResponse, stash } from './utils.mjs'
 
 export default function handleState (pathSegs, request, response) {
diff --git a/test-engine/server/handle-test.mjs b/test-engine/server/handle-test.mjs
@@ -1,4 +1,3 @@
-
 import { noBodyStatus } from '../lib/defines.mjs'
 import { fixupHeader } from '../lib/header-fixup.mjs'
 import { sendResponse, getHeader, configs, stash, setStash, logRequest, logResponse } from './utils.mjs'
diff --git a/test-engine/server/utils.mjs b/test-engine/server/utils.mjs
@@ -1,4 +1,3 @@
-
 import { BLUE, NC } from '../lib/defines.mjs'
 
 export function sendResponse (response, statusCode, message) {
diff --git a/tests/authorization.mjs b/tests/authorization.mjs
@@ -1,4 +1,3 @@
-
 export default
 
 {
diff --git a/tests/cc-freshness.mjs b/tests/cc-freshness.mjs
@@ -1,4 +1,3 @@
-
 export default
 
 {
diff --git a/tests/cc-parse.mjs b/tests/cc-parse.mjs
@@ -1,4 +1,3 @@
-
 export default
 
 {
diff --git a/tests/cc-request.mjs b/tests/cc-request.mjs
@@ -1,6 +1,5 @@
-
-import * as templates from '../lib/templates.mjs'
-import * as utils from '../lib/utils.mjs'
+import * as templates from './lib/templates.mjs'
+import * as utils from './lib/utils.mjs'
 
 export default {
   name: 'Cache-Control Request Directives',
diff --git a/tests/cc-response.mjs b/tests/cc-response.mjs
@@ -1,4 +1,3 @@
-
 export default
 
 {
diff --git a/tests/cdn-cache-control.mjs b/tests/cdn-cache-control.mjs
@@ -1,4 +1,3 @@
-
 export default
 
 {
diff --git a/tests/conditional-etag.mjs b/tests/conditional-etag.mjs
@@ -1,4 +1,3 @@
-
 export default {
   name: 'Conditional Requests: If-None-Match and ETag',
   id: 'conditional-inm',
diff --git a/tests/conditional-lm.mjs b/tests/conditional-lm.mjs
@@ -1,4 +1,3 @@
-
 export default {
   name: 'Conditional Requests: If-Modified-Since and Last-Modified',
   id: 'conditional-lm',
diff --git a/tests/expires-freshness.mjs b/tests/expires-freshness.mjs
@@ -1,4 +1,3 @@
-
 export default
 
 {
diff --git a/tests/expires-parse.mjs b/tests/expires-parse.mjs
@@ -1,4 +1,3 @@
-
 export default
 
 {
diff --git a/tests/headers.mjs b/tests/headers.mjs
@@ -1,5 +1,5 @@
-import * as utils from '../lib/utils.mjs'
-import headerList from './header-list.mjs'
+import * as utils from './lib/utils.mjs'
+import headerList from './lib/header-list.mjs'
 
 const tests = []
 
diff --git a/tests/heuristic-freshness.mjs b/tests/heuristic-freshness.mjs
@@ -1,4 +1,4 @@
-import * as utils from '../lib/utils.mjs'
+import * as utils from './lib/utils.mjs'
 
 const tests = []
 
@@ -91,5 +91,5 @@ export default {
   id: 'heuristic',
   description: 'These tests check how caches handle heuristic freshness.',
   spec_anchors: ['heuristic.freshness'],
-  tests: tests
+  tests
 }
diff --git a/tests/invalidation.mjs b/tests/invalidation.mjs
@@ -1,5 +1,4 @@
-
-import * as templates from '../lib/templates.mjs'
+import * as templates from './lib/templates.mjs'
 
 const tests = []
 
@@ -93,5 +92,5 @@ export default {
   id: 'invalidation',
   description: 'These tests check how caches support  invalidation, including when it is triggered by the `Location` and `Content-Location` response headers.',
   spec_anchors: ['invalidation'],
-  tests: tests
+  tests
 }
diff --git a/tests/lib/header-list.mjs b/tests/lib/header-list.mjs
@@ -1,4 +1,3 @@
-
 export default [
   {
     name: 'Test-Header',
diff --git a/tests/lib/templates.mjs b/tests/lib/templates.mjs
diff --git a/tests/lib/utils.mjs b/tests/lib/utils.mjs
@@ -0,0 +1,20 @@
+const contentSeed = 1
+const contentStore = {}
+export function httpContent (csKey, contentLength = 15) {
+  if (csKey in contentStore) {
+    return contentStore[csKey]
+  } else {
+    let keySeed = 0
+    for (let i = 0; i < csKey.length; i++) {
+      keySeed += csKey.charCodeAt(i)
+    }
+    const contents = []
+    for (let i = 0; i < contentLength; ++i) {
+      const idx = ((i * keySeed * contentSeed) % 26) + 97
+      contents.push(String.fromCharCode(idx))
+    }
+    const content = contents.join('')
+    contentStore[csKey] = content
+    return content
+  }
+}
diff --git a/tests/method.mjs b/tests/method.mjs
@@ -1,4 +1,3 @@
-
 export default
 
 {
diff --git a/tests/other.mjs b/tests/other.mjs
@@ -1,6 +1,5 @@
-
-import * as templates from '../lib/templates.mjs'
-import * as utils from '../lib/utils.mjs'
+import * as templates from './lib/templates.mjs'
+import * as utils from './lib/utils.mjs'
 
 export default
 
diff --git a/tests/pragma.mjs b/tests/pragma.mjs
@@ -1,4 +1,3 @@
-
 export default
 
 {
diff --git a/tests/stale.mjs b/tests/stale.mjs
@@ -1,5 +1,4 @@
-
-import * as templates from '../lib/templates.mjs'
+import * as templates from './lib/templates.mjs'
 
 function makeStaleCheckCC (cc, value) {
   return {
diff --git a/tests/status.mjs b/tests/status.mjs
@@ -1,6 +1,5 @@
-
-import * as templates from '../lib/templates.mjs'
-import * as utils from '../lib/utils.mjs'
+import * as templates from './lib/templates.mjs'
+import * as utils from './lib/utils.mjs'
 
 const tests = []
 
@@ -115,5 +114,5 @@ export default {
   id: 'status',
   description: 'These tests check to see if a cache will store and reuse various status codes when they have explicit freshness information associated with them.',
   spec_anchors: ['response.cacheability'],
-  tests: tests
+  tests
 }
diff --git a/tests/surrogate-control.mjs b/tests/surrogate-control.mjs
@@ -1,4 +1,3 @@
-
 export default
 
 {
diff --git a/tests/update304.mjs b/tests/update304.mjs
@@ -1,5 +1,5 @@
-import * as utils from '../lib/utils.mjs'
-import headerList from './header-list.mjs'
+import * as utils from './lib/utils.mjs'
+import headerList from './lib/header-list.mjs'
 
 const tests = []
 
@@ -120,5 +120,5 @@ export default {
   id: 'update304',
   description: 'These tests check cache behaviour upon receiving a `304 Not Modified` response.',
   spec_anchors: ['freshening.responses'],
-  tests: tests
+  tests
 }
diff --git a/tests/updateHead.mjs b/tests/updateHead.mjs
diff --git a/tests/vary-parse.mjs b/tests/vary-parse.mjs
diff --git a/tests/vary.mjs b/tests/vary.mjs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`export let fetch = null`
`3`	`2`	`export let useBrowserCache = false`
`4`	`3`	`export let baseUrl = ''`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`import * as config from './config.mjs'`
`3`	`2`	`import { fixupHeader } from '../lib/header-fixup.mjs'`
`4`	`3`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`import * as config from './config.mjs'`
`3`	`2`	`import { makeTest, testResults } from './test.mjs'`
`4`	`3`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`import * as defines from '../lib/defines.mjs'`
`3`	`2`	`import { fixupHeader } from '../lib/header-fixup.mjs'`
`4`	`3`	`import * as utils from '../lib/utils.mjs'`