feat: Implement automated testing with GHA #32

levaitamas · 2025-04-01T12:43:44Z

If we want to stick to the env var, this line makes more sense to me:

Suggested change

bash $GITHUB_ACTION_PATH/build.sh

bash $ACTION_PATH/build.sh

BTW do we need this env var? This should work too:

Suggested change

bash $GITHUB_ACTION_PATH/build.sh

bash ${{ github.action_path }}/build.sh

I ended up removing the ACTION_PATH env var, can't quite remember why it was there to begin with, but it was not used anyway.
The GITHUB_ACTION_PATH has to stay tho, as ${{ github.action_path }} is a github context directive and can't be interpreted by the script executed on the runner.

The GITHUB_ACTION_PATH has to stay tho, as ${{ github.action_path }} is a github context directive and can't be interpreted by the script executed on the runner.

The shell script does not use the env var; using the context directive in this line is fine as the GHA runner reads it.

levaitamas · 2025-04-01T13:17:18Z

Cool! Note: on the long run we will enable just one option to simplify debugging.

The problem is: we use minikube now, but kind is more performant.

-Original file line number
+Diff line change
@@ -0,0 +1,9 @@
+    cd "${CONTEXT_PATH}" || exit 1
+    if [[ -z "${FILE_PATH}" ]]; then
+      docker build -t "${TAGS}" .
+    else
+      docker build -f "${FILE_PATH}" -t "${TAGS}" .
+    fi
+    IMAGE_NAME=$(echo "${TAGS}" | cut -d : -f1)
+    mkdir images
+    docker image save -o "images/${IMAGE_NAME}" "${TAGS}"

-Original file line number
+Diff line change
@@ -0,0 +1,16 @@
+    name: Test go
+    description: "Tests the go files with the given arguments"
+    inputs:
+      tests:
+        description: "The project(s) that should be tested (kubernetes tests only), if you want to run multiple, provide their name separated with spaces"
+        required: true
+        default: 'all'
+    runs:
+      using: composite
+      steps:
+        - name: Test go program
+          shell: bash
+          env:
+            PROJECT_PATH: ${{ github.workspace }}
+            TESTS: ${{ inputs.tests }}
+          run: bash ${{ github.action_path }}/main.sh

-Original file line number
+Diff line change
@@ -0,0 +1,17 @@
+    cd "${PROJECT_PATH}"/99-labs/code || exit 1
+    if [ "${TESTS}" = "all" ]; then
+      TESTS=("helloworld" "splitdim" "kvstore")
+    fi
+    for TEST in ${TESTS[@]}; do
+      pushd . > /dev/null
+      cd ${TEST} || exit 1
+      go mod download
+      go test ./... --tags=kubernetes --count 1
+      ret=$?
+      if [[ $ret -ne 0 ]]; then
+        exit $ret
+      fi
+      popd > /dev/null
+    done

-Original file line number
+Diff line change
@@ -0,0 +1,44 @@
+    name: "Kind setup"
+    description: "Installs and sets up a running kind cluster, including the cloud-provider-kind and istio for service mesh"
+    inputs:
+      istio:
+        description: "A flag weather to start the istio service mesh"
+        default: 'false'
+        required: false
+    runs:
+      using: composite
+      steps:
+        - name: Install kind and start cluster
+          uses: helm/kind-action@v1
+          with:
+            cluster_name: test
+            kubectl_version: 'v1.30.4'
+        - name: Load images to node(s)
+          shell: bash
+          run: |
+            for i in $(docker images --format "{{.Repository}}:{{.Tag}}" | grep ':test'); do
+              kind load docker-image -n test ${i}
+            done
+        - name: Install cloud-provider-kind and start in background
+          shell: bash
+          env:
+            VERSION: 0.6.0
+          run: |
+            curl -L https://github.com/kubernetes-sigs/cloud-provider-kind/releases/download/v${VERSION}/cloud-provider-kind_${VERSION}_linux_amd64.tar.gz \
+            | tar -xz
+            sudo mv cloud-provider-kind /usr/local/bin/
+            sudo chmod +x /usr/local/bin/cloud-provider-kind
+            cloud-provider-kind &
+        - name: Start istio service mesh
+          if: inputs.istio == 'true'
+          shell: bash
+          run: |
+            curl -L https://istio.io/downloadIstio | sh -
+            cd istio*
+            kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd?ref=v1.0.0" | kubectl apply -f -
+            bin/istioctl install --set profile=minimal -y
+            kubectl label namespace default istio-injection=enabled --overwrite

-Original file line number
+Diff line change
@@ -0,0 +1,18 @@
+    name: Load built images
+    description: "Loads the previously built images and deletes the artifacts after"
+    runs:
+      using: composite
+      steps:
+        - name: Load images
+          shell: bash
+          run: |
+            for i in $(ls images); do
+            docker image load < "images/$i"
+            done
+        - name: Delete artifacts
+          uses: geekyeggo/delete-artifact@v5
+          with:
+            useGlob: 'true'
+            name: '*'
+            failOnError: false

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Implement automated testing with GHA #32

Uh oh!

Diff view

Diff view

There are no files selected for viewing

levaitamas Apr 1, 2025

Uh oh!

benjoe1126 May 24, 2025 •

edited

Loading

Uh oh!

levaitamas May 27, 2025

Uh oh!

Uh oh!

levaitamas Apr 1, 2025

Uh oh!

levaitamas Apr 1, 2025

Uh oh!

Uh oh!

Uh oh!

-Original file line number
+Diff line change
@@ -0,0 +1,7 @@
+    cd ${PROJECT_PATH}/99-labs/code/splitdim/deploy || exit 1
+    kubectl apply -f kubernetes-istio.yaml
+    bash ${ACTION_PATH}/wait.sh
+    export EXTERNAL_IP=$(kubectl get service splitdim-istio -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
+    export EXTERNAL_PORT=80
+    cd ..
+    go test ./... --tags=httphandler,api,localconstructor,reset,transfer,accounts,clear -v -count 1

-Original file line number
+Diff line change
@@ -0,0 +1,14 @@
+    SECONDS=0
+    while true; do
+      kubectl get svc #for debug
+      IP=$(kubectl get service splitdim-istio -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
+      if [[ ! -n "$IP" ]]; then
+        if (( SECONDS == 15));then
+          exit 1
+        fi
+        SECONDS=$(( SECONDS + 1 ))
+        sleep 1
+      else
+        exit 0
+      fi
+    done

-Original file line number
+Diff line change
@@ -0,0 +1,46 @@
+    name: Test Homeworks
+    on:
+      push:
+        branches:
+          - master
+        paths-ignore:
+          - 99-labs
+          - env
+          - internals
+          - .gitignore
+      workflow_dispatch:
+        inputs:
+          report:
+            type: boolean
+            description: If true then the pipeline creates a report json used for final evaluation and doesn't execute regular tests
+            default: false
+    jobs:
+      test-homeworks:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v4
+            with:
+              fetch-depth: '1'
+          - name: Setup go
+            uses: actions/setup-go@v5
+            with:
+              go-version: '^1.24.0'
+          - name: Test homeworks
+            if: ! inputs.report || github.event_name == 'push'
+            run: |
+              export STUDENT_ID="$(grep -v -e '^$' STUDENT_ID)" # set the student_id used for test generation
+              make generate # generate the tests
+              make test
+          - name: Generate report
+            if: inputs.report
+            run: |
+              export STUDENT_ID="$(grep -v -e '^$' STUDENT_ID)" # set the student_id used for test generation
+              make generate
+              make report
+          - name: Artifact report
+            if: inputs.report
+            uses: actions/upload-artifact@v4
+            with:
+              name: 'report'
+              path: '*-report.json'

-Original file line number
+Diff line change
@@ -0,0 +1,78 @@
+    name: Test
+    on:
+      workflow_dispatch:
+        inputs:
+          kube-distro:
+            type: choice
+            description: "The type of kubernetes distribution to use, i.e minikube, kind"
+            options:
+              - minikube
+              - kind
+            default: kind
+            required: false
+          istio-ready:
+            type: boolean
+            description: "Set to true if istio can be tested, leave false otherwise"
+            required: false
+          kubernetes-tests:
+            type: string
+            description: "Kubernetes tests to be run. Options: 'helloworld' 'splitdim', 'kvstore', 'all'.  if you want to run multiple, provide them separated with spaces (e.g., 'kvstore splitdim'); 'all' means execute all tests"
+            default: 'all'
+            required: false
+    jobs:
+      build:
+        runs-on: ubuntu-latest
+        strategy:
+          matrix:
+            image-root: ['helloworld','kvstore', 'splitdim']
+        steps:
+          - uses: actions/checkout@v4
+          - uses: ./.github/templates/docker
+            with:
+              path: ${{ github.workspace }}/99-labs/code/${{ matrix.image-root }}
+              filepath: ${{ github.workspace }}/99-labs/code/${{ matrix.image-root }}/deploy/Dockerfile
+              tags: ${{ matrix.image-root }}:test
+      test:
+        runs-on: ubuntu-latest
+        needs: build
+        steps:
+          - uses: actions/checkout@v4
+            with:
+              fetch-depth: '1'
+          - uses: actions/download-artifact@v4
+            with:
+              path: images
+              merge-multiple: 'true'
+          - name: Load all docker images
+            uses: ./.github/templates/load-images
+          - name: Setup go
+            uses: actions/setup-go@v5
+            with:
+              go-version: '^1.23.0'
+          - name: Start kind cluster
+            if: github.event.inputs.kube-distro == 'kind'
+            uses: ./.github/templates/kind-cluster-setup
+            with:
+              istio: 'true'
+          - name: Start minikube cluster
+            if: github.event.inputs.kube-distro == 'minikube'
+            uses: ./.github/templates/minikube-cluster-setup
+            with:
+              istio: 'true'
+          - name: Test istio
+            if: github.event.inputs.istio-ready == true
+            uses: ./.github/templates/test-istio
+          - name: Test go project
+            uses: ./.github/templates/go
+            with:
+              tests: ${{ github.event.inputs.kubernetes-tests }}

-Original file line number
+Diff line change
@@ Expand Up / @@ -8,4 +8,4 @@ The sorting should satisfy the following requirements: @@
     An example for the usage:
     {{ index . "example" }}
-    Place your code into the file `exercise.go` near the placeholder `// INSERT YOUR CODE HERE`.
+    Place your code into the file `exercise.go` near the placeholder `// INSERT YOUR CODE HERE`.

-Original file line number
+Diff line change
@@ Expand Up / @@ -3,7 +3,6 @@ @@
     package main
     import (
-    	"context"
     	"fmt"
     	"io"
     	"net"
@@ Expand All / @@ -17,17 +16,10 @@ import ( @@
     )
     func TestHelloWorldKubernetes(t *testing.T) {
-    	ctx, cancel := context.WithCancel(context.Background())
-    	defer cancel()
     	// clean up cluster
     	execCmd(t, "kubectl", "delete", "-f", "deploy/kubernetes-deployment.yaml")
     	execCmd(t, "kubectl", "delete", "-f", "deploy/kubernetes-service.yaml")
-    	// build the container image
-    	execCmd(t, "minikube", "image", "build", "-t", "helloworld", "-f", "deploy/Dockerfile", ".")
-    	go execCmd(t, "minikube", "tunnel")
     	// redeploy
     	execCmd(t, "kubectl", "apply", "-f", "deploy/kubernetes-deployment.yaml")
     	execCmd(t, "kubectl", "apply", "-f", "deploy/kubernetes-service.yaml")
@@ Expand All / @@ -37,8 +29,6 @@ func TestHelloWorldKubernetes(t *testing.T) { @@
     	ip, _ := execCmd(t, "kubectl", "get", "service", "helloworld", "-o", `jsonpath="{.status.loadBalancer.ingress[0].ip}"`)
     	if ip == "" {
-    		// make sure minikube tunnel is running if no public IP exists
-    		execCmdContext(ctx, t, "minikube", "tunnel")
     		// may take a while
     		time.Sleep(10 * time.Second)
     		ip, _ = execCmd(t, "kubectl", "get", "service", "helloworld", "-o", `jsonpath="{.status.loadBalancer.ingress[0].ip}"`)
@@ Expand Down @@

feat: Implement automated testing with GHA #32

Are you sure you want to change the base?

Uh oh!

feat: Implement automated testing with GHA #32

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

levaitamas Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

benjoe1126 May 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

levaitamas May 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

levaitamas Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

levaitamas Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

benjoe1126 May 24, 2025 •

edited

Loading