RUM-4079 chore: Migrate lint, tests and ui-tests to GitLab

[ncreated]

What and why?

📦 🧰 This PR migrates a significant portion of our CI setup to GitLab:

• ✅ Lint
• ✅ Unit tests
• ✅ UI tests

The following integrations are still running on Bitrise:

• ❌ SR snapshot tests - these will be moved to GitLab after upgrading our macOS runner to Xcode 15.4 and installing the iOS 17.5 runtime.
• ❌ Smoke tests
• ❌ Tooling tests
• ❌ Dogfooding automation
• ❌ Release automation
• ❌ E2E tests app upload to s8s

I will address the remaining items in subsequent PR(s).

How?

General Remarks:

• The performance and stability of tests on the GitLab runner are comparable to running them on a local laptop.
• We're using a dedicated macos:sonoma runner, which currently lacks some components. I plan to update the AMI; however, in the meantime, missing components are installed at runtime and persisted, minimizing setup times.
• For convenience of argument parsing in .sh scripts, I employed argparse-sh via my fork argparse-zsh.

Makefile

GitLab integrates changes through make commands, structured as follows:

.gitlab-ci.yml → Makefile → ./tools/*

Main motivations for the Makefile design:

• Modularity: This allows us to easily replicate CI commands locally by copying them directly from the CI logs, e.g.:

• Utility: Several commands facilitate local development.

List of key commands:

• Utility & Setup:
  • make env-check - Validates the presence of required CLI tools and displays their versions.
  • make repo-setup - Prepares the repo for development and testing (ENV="dev" | "ci").
  • make clean - Resets the repository state, clearing prebuilt artifacts and configurations.
• Lint:
  • make lint - Lints SDK and tests code.
  • make license-check - Ensures Apache 2.0 license headers are present.
• Unit Testing:
  • make test - Runs unit tests based on specified parameters (SCHEME, OS, PLATFORM, DEVICE).
  • make test-ios - Runs iOS Simulator unit tests for a specific scheme.
  • make test-ios-all - Runs iOS tests for all schemes.
  • make test-tvos - Runs tvOS Simulator unit tests for a specific scheme.
  • make test-tvos-all - Runs tvOS tests for all schemes.
• UI Testing:
  • make ui-test - Runs UI tests based on specified parameters (TEST_PLAN, OS, PLATFORM, DEVICE).
  • make ui-test-all - Runs UI tests for all test plans.
  • make ui-test-podinstall - Prepares the UI Tests project for development.
• Code Generation:
  • make models-generate - Generates models from rum-events-format.
  • make models-verify - Validates models against rum-events-format.

CI Parallelisation

The CI setup is designed to be efficient and modular, with three sequential stages containing multiple parallel jobs. The motivations are:

• Fail Fast: Identify and stop processes at the first sign of a failure, such as linting errors.
• Easy Retry: Allow easy retries of specific stages if flakiness occurs.

We split UI Tests into four distinct plans: "Default", "CrashReporting", "NetworkInstrumentation", and "RUM". Current job durations are optimal, hence further optimizations like caching are considered premature at this stage:

Review checklist

• Feature or bugfix MUST have appropriate tests (unit, integration)
• Make sure each commit and the PR mention the Issue number or JIRA reference
• Add CHANGELOG entry for user facing changes

Custom CI job configuration (optional)

• Run unit tests for Core, RUM, Trace, Logs, CR and WVT
• Run unit tests for Session Replay
• Run integration tests
• Run smoke tests
• Run tests for tools/

[ganeshnj]

Nicely done, left some improvement suggestions but nothing blocking.

Great job 🎉

[maxep]

Well done 👏 👏 I like the argparse.sh and echo_color.sh 🌈 utilities!

[maxep]

🚀