Remove old CI files and rename integrations.yml to lint-unit.yml

SUSE · Feb 6, 2024 · 4fb683d · 4fb683d
1 parent 87169e8
commit 4fb683d
Show file tree

Hide file tree

Showing 14 changed files with 46 additions and 347 deletions.
diff --git a/.github/workflows/integrations.yml → .github/workflows/lint-unit.yml b/.github/workflows/integrations.yml → .github/workflows/lint-unit.yml
@@ -72,5 +72,5 @@ jobs:
       - name: Run version checks
         run: |
           echo "::group::Version verification checks"
-          ruby integration/ci_check.rb
+          ruby ci/check-version-matches.rb
           echo "::endgroup::"
diff --git a/Jenkinsfile b/Jenkinsfile
diff --git a/ci/README.md b/ci/README.md
@@ -1,3 +1,46 @@
 ## RMT CI setup
 
-tbd
+Our CI setup runs the following steps:
+
+### Lint and unit tests
+
+workflow definition: [.github/workflows/lint-unit.yml](https://github.com/SUSE/rmt/blob/master/.github/workflows/lint-unit.yml)
+
+This workflow runs rubocop to check if the source is well formated and afterwards unit tests and engine unit tests. At last it checks
+if version in RMT and the rpm spec file matches.
+
+**Running it locally**
+
+There is no special mechanism needed to run these steps locally. Check the workflow for hints how to run unit tests
+
+### CLI feature tests
+
+workflow definition: [.github/workflows/features.yml](https://github.com/SUSE/rmt/blob/master/.github/workflows/features.yml)
+
+This workflow runs our simple CLI feature tests und build the rpm beforehand to see the system working with an installed RMT rpm.
+
+**Running it locally**
+
+To run feature tests locally, you need:
+
+- A checkout of RMT
+- A running mysql database
+- Proxy credentials to synchronize product information with SCC
+
+```
+# Fetch the CI container
+$ export IMAGE="registry.opensuse.org/systemsmanagement/scc/containers/15.5/rmt-ci-container:latest"
+
+# Build RMT rpms with the CI container the resulting rpms are in tmp/artifacts/
+$ docker run --rm -it -v $(pwd):/usr/src/rmt-server $IMAGE 'ci/rmt-build-rpm'
+
+# Run feature tests in the CI container
+# Note: Running --network=host isn't stricly required if you setup mysql access otherwise
+$ docker run --rm -it -v $(pwd):/usr/src/rmt-server --network=host $IMAGE bash -c 'ci/rmt-build-rpm && ci/rmt-configure && ci/rmt-run-feature-tests'
+```
+
+### The CI container
+
+Our CI container is built here: https://build.opensuse.org/package/show/systemsmanagement:SCC:containers/rmt-ci-container
+
+On push to Github master the rebuilt of the container is triggered
diff --git a/integration/ci_check.rb → ci/check-version-matches.rb b/integration/ci_check.rb → ci/check-version-matches.rb
@@ -1,4 +1,5 @@
 #! /usr/bin/env ruby
+
 def modified_files
   `git fetch origin master`
   `git diff --name-only origin/master`.strip.split "\n"

diff --git a/ci/rmt-console b/ci/rmt-console
diff --git a/integration/Dockerfile.test b/integration/Dockerfile.test
diff --git a/integration/Jenkinsfile b/integration/Jenkinsfile
diff --git a/integration/create-oscrc.sh b/integration/create-oscrc.sh
diff --git a/integration/create-rmt-conf.sh b/integration/create-rmt-conf.sh
diff --git a/integration/install.sh b/integration/install.sh
diff --git a/integration/prophet/.prophet_ci.yml b/integration/prophet/.prophet_ci.yml
diff --git a/integration/prophet/ci_executor.rb b/integration/prophet/ci_executor.rb
diff --git a/integration/prophet/prophet.rb b/integration/prophet/prophet.rb