Add multi-trail artifact workflow and supporting scripts for Kosli integration

Author: sofusalbertsen

.github/workflows/multi-trail-artifact.yml

@@ -0,0 +1,69 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Multi Trail Artifact
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the "main" branch
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+env: # Set the secret as an input
+  APP_NAME: ${{ github.event.repository.name }}
+  BUILD_NUMBER: ${{ github.run_number }}
+  GIT_REPO: ${{ github.repository }}
+  GIT_REPO_URL: ${{ github.event.repository.clone_url }}
+  GIT_BRANCH: ${{ github.ref_name }}
+  GIT_COMMIT: ${{ github.sha }}
+  BUILD_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+  COMMIT_URL: ${{ github.server_url }}/${{ github.repository }}/commit/${{ github.sha }}
+  KOSLI_API_TOKEN: ${{ secrets.KOSLI_API_KEY }} # Set the Kosli API token as a secret in your repository
+  KOSLI_ORG: sofusalbertsen
+  KOSLI_FLOW: multi-trail-artifact
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    strategy:
+      matrix:
+        flow: [1, 2, 3] # Define a matrix to run the same job for multiple flows
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v4
+      - name: setup-kosli-cli
+        uses: kosli-dev/setup-cli-action@v2
+      - name: Update Flow
+        run: kosli create flow ${{env.KOSLI_FLOW}}${{matrix.flow}} --description "Flow${{matrix.flow}} for multi-flow-artifact" --template-file=${{env.KOSLI_FLOW}}/kosli-config/flow.yaml
+      # Runs a single command using the runners shell
+      - name: run the scenario up
+        run: bash ${{env.KOSLI_FLOW}}/1.sh
+  output:
+      name: kosli-output
+      runs-on: ubuntu-latest
+      needs: build
+      steps:
+        - name: Check Kosli Output
+          run: |
+            kosli get trail -o json ${GIT_COMMIT} > data.json
+            echo "Kosli output saved to data.json"
+            cat data.json
+        - name: opload-artifact
+          uses: actions/[email protected]
+          with:
+            path: data.json
+        - name: Check Artifacts
+          run: |
+            if grep -q '"name": "app"' data.json; then
+              echo "Artifact 'app' found in the trail."
+            else
+              echo "Artifact 'app' not found in the trail."
+              exit 1
+            fi

multi-trail-artifact/1.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+set -e
+# Get the current git commit SHA
+GIT_SHA=$(git rev-parse HEAD)
+ARTIFACT=artifact.txt
+# Write the SHA to artifact.txt
+echo "Git sha is: $GIT_SHA" > $ARTIFACT
+# This script performs the following Kosli operations:
+# 1. Begins a new Kosli trail for the specified Git commit, adding a description with the build number.
+# 2. Attests an artifact to the Kosli trail, specifying artifact type, commit URL, commit hash, artifact file, build URL, and artifact name.
+# 3. Retrieves the Kosli trail data in JSON format and saves it to 'data.json'.
+#
+# Required environment variables:
+# - GIT_COMMIT: The Git commit hash to associate with the Kosli trail.
+# - BUILD_NUMBER: The build number for description purposes.
+# - COMMIT_URL: The URL to the commit in the source control system.
+# - ARTIFACT: The path to the artifact file to attest.
+# - BUILD_URL: The URL to the build/job in the CI system.
+
+kosli begin trail ${GIT_COMMIT} --description "build number ${BUILD_NUMBER}"
+kosli attest artifact --trail=${GIT_COMMIT} --artifact-type=file --commit-url=${COMMIT_URL} --commit=${GIT_COMMIT} $ARTIFACT --build-url=${BUILD_URL} --name=app
+kosli get trail -o json ${GIT_COMMIT} > data.json

multi-trail-artifact/README.md

@@ -0,0 +1,15 @@
+# Multi trail artifact
+
+This scenario exams the way Kosli behaves when the same binary artifact gets created multiple times, either in different flows, or in different git commits.
+
+To test this, we mimic a monorepo. It is set up to have one GH action workflow per `application` in the repo; N workflows.
+
+Given that all workflows riggers on all commits, that would translate into N flows, with N trails, all trails having the same name.
+
+## Scenario 1
+
+What would happen if we were to do a kosli search on an artifact having multiple trails with the same name (stemming from same commit)?
+
+## Scenario 2
+
+What would happen if we do a kosli search on an artifact that has been produced several times over multiple git commits.

multi-trail-artifact/kosli-config/flow.yaml

@@ -0,0 +1,4 @@
+version: 1
+trail:
+  artifacts:
+    - name: app

multi-trail-artifact/show-trails.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+set -e
+echo "to be implemented"