feat: output workflow url with test metadata

.github/actions/test/action.yml

@@ -40,12 +40,13 @@ runs:
  SUBDOMAIN: ${{ inputs.subdomain-url }}
  JSON: ${{ inputs.json }}
  SPECS: ${{ inputs.specs }}
+ JOB_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
  with:
  repository: ${{ steps.github.outputs.action_repository }}
  ref: ${{ steps.github.outputs.action_sha || steps.github.outputs.action_ref }}
  dockerfile: Dockerfile
  opts: --network=host
- args: test --url="$URL" --json="$JSON" --specs="$SPECS" --subdomain-url="$SUBDOMAIN" -- ${{ inputs.args }}
+ args: test --url="$URL" --json="$JSON" --specs="$SPECS" --subdomain-url="$SUBDOMAIN" --job-url="$JOB_URL" -- ${{ inputs.args }}
  build-args: |
  VERSION:${{ steps.github.outputs.action_ref }}
  - name: Create the XML

.github/workflows/test-prod-e2e.yml

@@ -39,7 +39,7 @@ jobs:
  path_to_add: 'fixtures.car'
  - name: Wait for pinning
  run: |
- sleep 180 # 3 minutes
+ sleep 20 # 20 seconds
  # see rational in https:/ipfs/gateway-conformance/pull/108#discussion_r1274628865
  test:
  runs-on: "ubuntu-latest"

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - `--version` flag shows the current version
 - Metadata logging used to associate tests with custom data like versions, specs identifiers, etc.
+- Output Github's workflow URL with metadata. [PR](https:/ipfs/gateway-conformance/pull/145)
 
 ## [0.3.0] - 2023-07-31
 ### Added

Makefile

@@ -34,7 +34,10 @@ fixtures.car: gateway-conformance
  ./gateway-conformance extract-fixtures --merged=true --dir=.
 
 gateway-conformance:
- go build -ldflags="-X github.com/ipfs/gateway-conformance/tooling.Version=$(CLI_VERSION)" -o ./gateway-conformance ./cmd/gateway-conformance
+ go build \
+ -ldflags="-X github.com/ipfs/gateway-conformance/tooling.Version=$(CLI_VERSION)" \
+ -o ./gateway-conformance \
+ ./cmd/gateway-conformance
 
 test-docker: docker fixtures.car gateway-conformance
  ./gc test

aggregate-into-table.js

@@ -58,8 +58,14 @@ inputs.forEach((input, index) => {
  // extract TestMetadata & version
  const metadata = input[TestMetadata]["meta"];
  const version = metadata['version'];
+ const jobURL = metadata['job_url'];
 
- const col = [name, version];
+ let versionCell = version
+ if (jobURL) {
+ versionCell = `[${version}](${jobURL})`;
+ }
+
+ const col = [name, versionCell];
 
  // extract results
  keys.forEach((key) => {

cmd/gateway-conformance/main.go

@@ -72,6 +72,7 @@ func main() {
  var gatewayURL string
  var subdomainGatewayURL string
  var jsonOutput string
+ var jobURL string
  var specs string
  var directory string
  var merged bool
@@ -107,6 +108,13 @@ func main() {
  Value: "",
  Destination: &jsonOutput,
  },
+ &cli.StringFlag{
+ Name: "job-url",
+ Aliases: []string{},
+ Usage: "The Job URL where this run will be visible.",
+ Value: "",
+ Destination: &jobURL,
+ },
  &cli.StringFlag{
  Name: "specs",
  Usage: "Accepts a spec (test only this spec), a +spec (test also this immature spec), or a -spec (do not test this mature spec).",
@@ -127,7 +135,7 @@ func main() {
  args = append(args, fmt.Sprintf("-specs=%s", specs))
  }
 
- ldFlag := fmt.Sprintf("-ldflags=-X github.com/ipfs/gateway-conformance/tooling.Version=%s", tooling.Version)
+ ldFlag := fmt.Sprintf("-ldflags=-X github.com/ipfs/gateway-conformance/tooling.Version=%s -X github.com/ipfs/gateway-conformance/tooling.JobURL=%s", tooling.Version, jobURL)
  args = append(args, ldFlag)
 
  args = append(args, cCtx.Args().Slice()...)

tests/metadata_test.go

@@ -8,4 +8,5 @@ import (
 
 func TestMetadata(t *testing.T) {
  tooling.LogVersion(t)
+ tooling.LogJobURL(t)
 }

tooling/env.go

@@ -8,6 +8,7 @@ import (
 
 var (
  Version = "dev"
+ JobURL = ""
 )
 
 func Home() string {

tooling/metadata.go

@@ -6,6 +6,8 @@ import (
 )
 
 func LogMetadata(t *testing.T, value interface{}) {
+ t.Helper()
+
  jsonValue, err := json.Marshal(value)
  if err != nil {
  t.Errorf("Failed to encode value: %v", err)
@@ -21,3 +23,11 @@ func LogVersion(t *testing.T) {
  Version: Version,
  })
 }
+
+func LogJobURL(t *testing.T) {
+ LogMetadata(t, struct {
+ JobURL string `json:"job_url"`
+ }{
+ JobURL: JobURL,
+ })
+}