Skip to content

Commit

Permalink
Added the wrapper and changes to the workflow pipeline
Browse files Browse the repository at this point in the history
Signed-off-by: asim <[email protected]>
  • Loading branch information
asimchoudhary committed Jan 23, 2025
1 parent c3ada21 commit 107fef7
Show file tree
Hide file tree
Showing 2 changed files with 194 additions and 123 deletions.
245 changes: 122 additions & 123 deletions .github/workflows/ci-lint-checks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,175 +12,174 @@ concurrency:
cancel-in-progress: true

# See https://github.com/ossf/scorecard/blob/main/docs/checks.md#token-permissions
permissions: # added using https://github.com/step-security/secure-workflows
permissions: # added using https://github.com/step-security/secure-workflows
contents: read

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
with:
egress-policy: audit # TODO: change to 'egress-policy: block' after a couple of runs
- uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
with:
egress-policy: audit # TODO: change to 'egress-policy: block' after a couple of runs

- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0

- uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0
with:
go-version: 1.23.x
- uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0
with:
go-version: 1.23.x

- name: Print Jaeger version for no reason
run: make echo-v1 echo-v2
- name: Print Jaeger version for no reason
run: make echo-v1 echo-v2

- run: make install-test-tools
- run: make install-test-tools

- run: make lint
- run: make lint

pull-request-preconditions:
runs-on: ubuntu-latest
steps:
- uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
with:
egress-policy: audit # TODO: change to 'egress-policy: block' after a couple of runs
- uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
with:
egress-policy: audit # TODO: change to 'egress-policy: block' after a couple of runs

- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0

- uses: ./.github/actions/block-pr-from-main-branch
- uses: ./.github/actions/block-pr-from-main-branch

- run: |
git fetch origin main
make lint-nocommit
- run: |
git fetch origin main
make lint-nocommit
dco-check:
runs-on: ubuntu-latest
steps:
- uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
with:
egress-policy: audit # TODO: change to 'egress-policy: block' after a couple of runs
- uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
with:
egress-policy: audit # TODO: change to 'egress-policy: block' after a couple of runs

- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0

- name: Set up Python 3.x for DCO check
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
with:
python-version: '3.x'
- name: Set up Python 3.x for DCO check
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
with:
python-version: "3.x"

- name: Run DCO check
run: python3 scripts/lint/dco_check.py -b main -v --exclude-pattern '@users\.noreply\.github\.com'
env:
- name: Run DCO check
run: python3 scripts/lint/dco_check.py -b main -v --exclude-pattern '@users\.noreply\.github\.com'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

generated-files-check:
runs-on: ubuntu-latest
steps:
- uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
with:
egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs
- uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
with:
egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs

- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
with:
submodules: recursive
- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
with:
submodules: recursive

- uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0
with:
go-version: 1.23.x
- uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0
with:
go-version: 1.23.x

- name: Verify Protobuf types are up to date
run: make proto && git diff --name-status --exit-code
- name: Verify Protobuf types are up to date
run: make proto && git diff --name-status --exit-code

- name: Verify Thrift types are up to date
run: make thrift && git diff --name-status --exit-code
- name: Verify Thrift types are up to date
run: make thrift && git diff --name-status --exit-code

- name: Verify Mockery types are up to date
run: make generate-mocks && { if git status --porcelain | grep '??'; then exit 1; else git diff --name-status --exit-code; fi }
- name: Verify Mockery types are up to date
run: make generate-mocks && { if git status --porcelain | grep '??'; then exit 1; else git diff --name-status --exit-code; fi }

lint-shell-scripts:
runs-on: ubuntu-latest

steps:
- uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
with:
egress-policy: audit
- uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
with:
egress-policy: audit

- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0

- run: sudo apt-get install shellcheck
- run: sudo apt-get install shellcheck

- run: shellcheck scripts/**/*.sh
- run: shellcheck scripts/**/*.sh

- name: Install shunit2 for shell unit tests
uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
with:
repository: kward/shunit2
path: .tools/shunit2
- name: Install shunit2 for shell unit tests
uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
with:
repository: kward/shunit2
path: .tools/shunit2

- name: Run unit tests for scripts
run: |
SHUNIT2=.tools/shunit2 bash scripts/utils/compute-tags.test.sh
- name: Run unit tests for scripts
run: |
SHUNIT2=.tools/shunit2 bash scripts/utils/run-tests.sh
binary-size-check:
runs-on: ubuntu-latest
steps:
- uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
with:
egress-policy: audit

- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
with:
submodules: true

- uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0
with:
go-version: 1.23.x

- name: Setup Node.js version
uses: ./.github/actions/setup-node.js

- name: Build jaeger binary
run: make build-jaeger

- name: Calculate jaeger binary size
run: |
TOTAL_SIZE=$(du -sb ./cmd/jaeger/jaeger-linux-amd64 | cut -f1)
echo "$TOTAL_SIZE" > ./new_jaeger_binary_size.txt
echo "Total binary size: $TOTAL_SIZE bytes"
- name: Restore previous binary size
id: cache-binary-size
uses: actions/cache/restore@1bd1e32a3bdc45362d1e726936510720a7c30a57 #v4.2.0
with:
path: ./jaeger_binary_size.txt
key: jaeger_binary_size
restore-keys: |
jaeger_binary_size
- name: Compare jaeger binary sizes
if: steps.cache-binary-size.outputs.cache-matched-key != ''
run: |
OLD_BINARY_SIZE=$(cat ./jaeger_binary_size.txt)
NEW_BINARY_SIZE=$(cat ./new_jaeger_binary_size.txt)
echo "Previous binary size: $OLD_BINARY_SIZE bytes"
echo "New binary size: $NEW_BINARY_SIZE bytes"
SIZE_CHANGE=$(( $NEW_BINARY_SIZE - $OLD_BINARY_SIZE ))
PERCENTAGE_CHANGE=$(( SIZE_CHANGE * 100 / $OLD_BINARY_SIZE ))
echo "Size change: $PERCENTAGE_CHANGE%"
if [ $PERCENTAGE_CHANGE -gt 2 ]; then
echo "❌ binary size increased by more than 2% ($PERCENTAGE_CHANGE%)"
exit 1
else
echo "✅ binary size change is within acceptable range ($PERCENTAGE_CHANGE%)"
fi

- name: Remove previous *_binary_*.txt
run: |
rm -rf ./jaeger_binary_size.txt
mv ./new_jaeger_binary_size.txt ./jaeger_binary_size.txt
- name: Save new jaeger binary size
if: ${{ (github.event_name == 'push') && (github.ref == 'refs/heads/main') }}
uses: actions/cache/save@1bd1e32a3bdc45362d1e726936510720a7c30a57 #v4.2.0
with:
path: ./jaeger_binary_size.txt
key: jaeger_binary_size_${{ github.run_id }}
- uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
with:
egress-policy: audit

- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
with:
submodules: true

- uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0
with:
go-version: 1.23.x

- name: Setup Node.js version
uses: ./.github/actions/setup-node.js

- name: Build jaeger binary
run: make build-jaeger

- name: Calculate jaeger binary size
run: |
TOTAL_SIZE=$(du -sb ./cmd/jaeger/jaeger-linux-amd64 | cut -f1)
echo "$TOTAL_SIZE" > ./new_jaeger_binary_size.txt
echo "Total binary size: $TOTAL_SIZE bytes"
- name: Restore previous binary size
id: cache-binary-size
uses: actions/cache/restore@1bd1e32a3bdc45362d1e726936510720a7c30a57 #v4.2.0
with:
path: ./jaeger_binary_size.txt
key: jaeger_binary_size
restore-keys: |
jaeger_binary_size
- name: Compare jaeger binary sizes
if: steps.cache-binary-size.outputs.cache-matched-key != ''
run: |
OLD_BINARY_SIZE=$(cat ./jaeger_binary_size.txt)
NEW_BINARY_SIZE=$(cat ./new_jaeger_binary_size.txt)
echo "Previous binary size: $OLD_BINARY_SIZE bytes"
echo "New binary size: $NEW_BINARY_SIZE bytes"
SIZE_CHANGE=$(( $NEW_BINARY_SIZE - $OLD_BINARY_SIZE ))
PERCENTAGE_CHANGE=$(( SIZE_CHANGE * 100 / $OLD_BINARY_SIZE ))
echo "Size change: $PERCENTAGE_CHANGE%"
if [ $PERCENTAGE_CHANGE -gt 2 ]; then
echo "❌ binary size increased by more than 2% ($PERCENTAGE_CHANGE%)"
exit 1
else
echo "✅ binary size change is within acceptable range ($PERCENTAGE_CHANGE%)"
fi
- name: Remove previous *_binary_*.txt
run: |
rm -rf ./jaeger_binary_size.txt
mv ./new_jaeger_binary_size.txt ./jaeger_binary_size.txt
- name: Save new jaeger binary size
if: ${{ (github.event_name == 'push') && (github.ref == 'refs/heads/main') }}
uses: actions/cache/save@1bd1e32a3bdc45362d1e726936510720a7c30a57 #v4.2.0
with:
path: ./jaeger_binary_size.txt
key: jaeger_binary_size_${{ github.run_id }}
72 changes: 72 additions & 0 deletions scripts/utils/run-tests.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
#!/bin/bash

# Copyright (c) 2025 The Jaeger Authors.
# SPDX-License-Identifier: Apache-2.0

set -euo pipefail

UTILS_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
REPO_ROOT="$UTILS_DIR/../.."

# Define list of test files explicitly here , to be dynamic to the location of the test file
TEST_FILES=(
"$UTILS_DIR/compute-tags.test.sh"
"$REPO_ROOT/plugin/storage/cassandra/schema/create.test.sh"
)

run_test_file() {
local test_file="$1"
if [ ! -f "$test_file" ]; then
echo "Error: Test file not found: $test_file"
return 1
fi

echo "Running tests from: $test_file"

export SHUNIT2="${SHUNIT2:?'SHUNIT2 environment variable must be set'}"

bash "$test_file"
local result=$?
echo "Test file $test_file completed with status: $result"
return $result
}

main() {

if [ ! -f "${SHUNIT2}/shunit2" ]; then
echo "Error: shunit2 not found at ${SHUNIT2}/shunit2"
exit 1
fi
local failed=0
local total=0
local passed=0
local failed_tests=()

# Run all test files
for test_file in "${TEST_FILES[@]}"; do
((total++))
if ! run_test_file "$test_file"; then
failed=1
failed_tests+=("$test_file")
else
((passed++))
fi
done

echo "-------------------"
echo "Test Summary:"
echo "Total: $total"
echo "Passed: $passed"
echo "Failed: $((total - passed))"

if [ ${#failed_tests[@]} -gt 0 ]; then
echo "Failed tests:"
for test in "${failed_tests[@]}"; do
echo " - $(basename "$test")"
fi
fi

exit $failed
}

main

0 comments on commit 107fef7

Please sign in to comment.