feat: generate placeholder dashboard & deploy to github pages

.github/actions/test/action.yml

@@ -62,7 +62,7 @@ runs:
         mode: no-frames
         input: ${{ inputs.xml }}
         output: ${{ inputs.html }}
-    - name: Create the HTML
+    - name: Create the Markdown
       if: inputs.markdown && (failure() || success())
       uses: pl-strflt/junit-xml-to-html@v1
       with:

.github/workflows/test-implementations-e2e.yml → .github/workflows/deploy-pages.yml

@@ -1,19 +1,29 @@
-name: Generate Implementations Dashboard
+name: Deploy Pages
 
 on:
   workflow_dispatch:
   push:
     branches:
       - main
-  pull_request:
   schedule:
     - cron: "* */1 * * *" # every one hour
 
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
 concurrency:
-  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event_name == 'push' && github.sha || github.ref }}
+  group: "pages"
   cancel-in-progress: true
 
+defaults:
+  run:
+    shell: bash
+
 jobs:
+  # Pulls the output.json from the latest successful run of the gateway-conformance.yml workflow
+  # and stores these as an artifacts for the build job.
   pull-outputs:
     runs-on: "ubuntu-latest"
     strategy:
@@ -54,36 +64,70 @@ jobs:
         with:
           name: conformance-${{ steps.get-details.outputs.name }}.json
           path: ./output.json
-  aggregate:
-    runs-on: "ubuntu-latest"
+  # https://github.com/actions/starter-workflows/blob/4a8f18e34dd13d2b6ee4d8da2ba72629eafe1609/pages/hugo.yml#L1
+  build:
+    runs-on: ubuntu-latest
+    env:
+      HUGO_VERSION: 0.117.0
     needs: [pull-outputs]
-    # the tests might have failed
-    if: always()
-    defaults:
-      run:
-        shell: bash
     steps:
-      - uses: actions/checkout@v3
+      - name: Setup Hugo
+        uses: peaceiris/actions-hugo@v2
+        with:
+          hugo-version: ${{ env.HUGO_VERSION }}
+          extended: true
+      - name: Checkout
+        uses: actions/checkout@v3
         with:
-          path: "gateway-conformance"
+          submodules: recursive
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v1
       - name: Download Artifacts
         uses: actions/download-artifact@v3
         with:
           path: artifacts
-      - name: Aggregate results
+      - name: Generate Data Aggregates
         working-directory: ./artifacts
         run: |
-          mkdir ./aggregates
+          mkdir ../aggregates
 
           # download-artifact downloads artifacts in a directory named after the artifact
           # details: https://github.com/actions/download-artifact#download-all-artifacts
           for folder in ./conformance-*.json; do
             file="${folder}/output.json"
-            new_file="aggregates/${folder#.\/conformance-}" # drop the ./conformance- prefix
-            jq -ns 'inputs' "$file" | node ../gateway-conformance/aggregate.js 1 > "${new_file}"
+            new_file="../aggregates/${folder#.\/conformance-}" # drop the ./conformance- prefix
+            jq -ns 'inputs' "$file" | node ../aggregate.js 1 > "${new_file}"
           done
-
-          node ../gateway-conformance/aggregate-into-table.js ./aggregates/*.json > ./table.md
-      - name: Set summary
+      - name: Upload Data Aggregates
+        # will be very useful for local debugging
         if: (failure() || success())
-        run: cat ./artifacts/table.md >> $GITHUB_STEP_SUMMARY
+        uses: actions/upload-artifact@v3
+        with:
+          name: dashboard-aggregates
+          path: ./aggregates
+      - name: Generate Content
+        run: |
+          node ./aggregate-into-table.js ./aggregates/*.json > ./table.md
+          cp ./table.md ./www/data/table.md
+          cat ./table.md >> $GITHUB_STEP_SUMMARY
+      - name: Build with Hugo
+        run: |
+          hugo \
+            --minify \
+            --baseURL ${{ steps.pages.outputs.base_url }}
+        working-directory: www
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: ./www/public
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

Makefile

@@ -50,6 +50,9 @@ test-docker: docker fixtures.car gateway-conformance
 	docker run --rm -v "${PWD}:/workspace" -w "/workspace" ghcr.io/pl-strflt/saxon:v1 -s:./reports/output.xml -xsl:/etc/junit-noframes-saxon.xsl -o:./reports/output.html
 	open ./reports/output.html
 
+./reports/output.md: ./reports/output.xml
+	docker run --rm -v "${PWD}:/workspace" -w "/workspace" ghcr.io/pl-strflt/saxon:v1 -s:./reports/output.xml -xsl:/etc/junit-summary.xsl -o:./reports/output.md
+
 docker:
 	docker build --build-arg VERSION="$(CLI_VERSION)" -t gateway-conformance .
 

aggregate-into-table.js

@@ -56,9 +56,14 @@ inputs.forEach((input, index) => {
     let name = files[index].replace(/\.json$/, '').replace(/^.*\//, '');
 
     // extract TestMetadata & version
-    const metadata = input[TestMetadata]["meta"];
-    const version = metadata['version'];
-    const jobURL = metadata['job_url'];
+    let version = 'unknown';
+    let jobURL = null;
+
+    if (input[TestMetadata]) {
+        const metadata = input[TestMetadata]["meta"];
+        version = metadata['version'];
+        jobURL = metadata['job_url'];
+    }
 
     let versionCell = version
     if (jobURL) {

www/.gitignore

@@ -0,0 +1,2 @@
+/.hugo_build.lock
+/public

www/archetypes/default.md

@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+

www/config.yaml

@@ -0,0 +1,17 @@
+baseURL: http://example.org/
+languageCode: en-us
+title: Gateway Conformance Dashboard
+
+theme:
+  - conformance
+  - sk1
+
+markup:
+  goldmark:
+    renderer:
+      unsafe: true
+
+taxonomies:
+  ipip: ipips
+  test: tests
+  result: results

www/content/_index.md

@@ -0,0 +1,26 @@
+---
+name: Home
+published: true
+date: 2023-08-14
+---
+
+# Gateway Conformance Dashboard
+
+<img src="{{< url "logo.png" >}}" style="max-width: 12rem;" />
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed tincidunt sagittis arcu, in tempus nisi molestie at. Suspendisse imperdiet viverra fringilla. Sed eleifend elementum sem. Phasellus orci lectus, laoreet in sapien vulputate, bibendum cursus neque. Quisque luctus dictum ligula, sit amet sagittis lacus consectetur eget. Phasellus non diam sem. Duis pellentesque tellus quis dolor sodales, vitae faucibus nulla ornare. Proin eget odio eu orci tristique volutpat. Nunc non vehicula neque. Maecenas volutpat mollis sem eget vestibulum.
+
+[Current Dashboard]({{< ref "/current" >}})
+
+## List of Gateway Implementation Tested
+
+{{< gateways-links >}}
+
+## List of Specs Tested
+
+{{< specs-links >}}
+
+## Related Projects:
+
+- ipip specs
+- etc

www/content/current.md

@@ -0,0 +1,7 @@
+---
+date: 2023-08-14
+---
+
+# Current
+
+{{< current-table >}}

www/content/specs/_index.md

@@ -0,0 +1,4 @@
+---
+---
+
+This is the entry-point for the conformance gateway dashboard when coming from the specs.

www/data/table.md

@@ -0,0 +1 @@
+placeholder

www/themes/conformance/layouts/shortcodes/current-table.html

@@ -0,0 +1,4 @@
+<div>
+    {{ $file := "data/table.md" }}
+    {{ $file | readFile | markdownify }}
+</div>

www/themes/conformance/layouts/shortcodes/gateways-links.html

@@ -0,0 +1 @@
+(Gateway Links Work In Progress)

www/themes/conformance/layouts/shortcodes/include.html

@@ -0,0 +1,2 @@
+{{ $file := .Get 0 }}
+{{ $file | readFile | markdownify }}

www/themes/conformance/layouts/shortcodes/specs-links.html

@@ -0,0 +1 @@
+(Specs Links Work In Progress)

www/themes/conformance/layouts/shortcodes/url.html

@@ -0,0 +1,2 @@
+{{/* make pathing for most URLs stable over any type of domain, base url, etc. */}}
+{{ .Get 0 | absURL }}

www/themes/conformance/theme.toml

@@ -0,0 +1,12 @@
+description = ""
+features = []
+homepage = ""
+license = ""
+licenselink = ""
+min_version = ""
+name = "conformance"
+tags = []
+
+[author]
+homepage = ""
+name = ""

www/themes/sk1/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 John Siu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

www/themes/sk1/README.md

@@ -0,0 +1,21 @@
+# Hugo Theme - SK1 (Skeleton 1)
+
+[![Paypal donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/donate/?business=HZF49NM9D35SJ&no_recurring=0&currency_code=CAD)
+
+Fully functional basic Hugo theme with no css, no javascript.
+
+Intended for learning hugo theme structure and functions.
+
+Heavily trimmed-down for the conformance-testing needs.
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2020 John Siu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

www/themes/sk1/layouts/404.html

@@ -0,0 +1,3 @@
+{{define "main"}}
+Page Not Found.
+{{end}}

www/themes/sk1/layouts/_default/baseof.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+{{- partial "head.html" . -}}
+
+<body>
+	{{- partial "header.html" . -}}
+	<div id="content">
+		{{- block "main" . }}{{- end }}
+	</div>
+	{{- partial "footer.html" . -}}
+</body>
+
+</html>

www/themes/sk1/layouts/_default/list.html

@@ -0,0 +1,25 @@
+{{define "main"}}
+
+<!--Content-->
+{{.Content}}
+
+<!--$paginator-->
+{{$p := .Pages}}
+{{if .IsHome}}
+{{$p = where site.RegularPages "Type" "in" site.Params.mainSections}}
+{{else if eq .Kind "taxonomy"}}
+{{$p = $p.ByTitle}}
+{{end}}
+{{$paginator := .Paginate $p}}
+
+<!--list-->
+<ul>
+	{{range $paginator.Pages}}
+	<li>{{.Date.Format "2006-01-02"}} | <a href="{{.RelPermalink}}">{{.Title}}</a></li>
+	{{end}}
+</ul>
+
+<!--pagination-->
+{{template "_internal/pagination.html" .}}
+
+{{end}}

www/themes/sk1/layouts/_default/single.html

@@ -0,0 +1,37 @@
+{{define "main"}}
+
+<!--Title-->
+<h2>{{.Title}}</h2>
+
+<!--Date-->
+{{.Date.Format "2006-01-02"}}
+
+<!--TOC-->
+{{.TableOfContents}}
+
+<!--Content-->
+{{.Content}}
+
+<!--Tag-->
+<ul>
+	{{range (.GetTerms "tags")}}
+	<li><a href="{{.RelPermalink}}">{{.LinkTitle}}</a></li>
+	{{end}}
+</ul>
+
+<!--Prev/Next-->
+{{with .PrevInSection}}Prev <a href="{{.RelPermalink}}">{{.Title}}</a>{{end}}
+{{with .NextInSection}}Next <a href="{{.RelPermalink}}">{{.Title}}</a>{{end}}
+
+<!--Related-->
+{{$related := .Site.RegularPages.Related . | first 5}}
+{{with $related}}
+<h3>See Also</h3>
+<ul>
+	{{range .}}
+	<li><a href="{{.RelPermalink}}">{{.Title}}</a></li>
+	{{end}}
+</ul>
+{{end}}
+
+{{end}}

www/themes/sk1/layouts/partials/footer.html

@@ -0,0 +1 @@
+{{with .Site.Copyright}}{{.}} / {{end}}

www/themes/sk1/layouts/partials/header.html

@@ -0,0 +1,4 @@
+<!--Site Title-->
+<a href="{{ "" | relLangURL}}">{{site.Title}}</a>
+<!--Sub-title-->
+{{with site.Params.subtitle}} / {{.}}{{end}}