Introduction

Project Cassini defines a GitLab CI/CD pipeline to help developers and reviewers by detecting issues at an early stage when a merge request is created.

To create a merge request on this project the user needs to be a member of the project and refer to Contributing for further details.

Overview

The following diagram illustrates brief overview of Project Cassini automated testing.

• External Tools:

  These tools are used by jobs in the pipeline and built in Docker containers ensuring running them in confined environment.

  • Packages:

    These are Debian packages provided from ubuntu.com

  • jfrog:

    The jfrog tool is provided from jfrog.io to communicate with artifactory.

  • SCT parser:

    The SCT parser is used to parse test results.

• External Images:

  External images used directly by the pipeline are pulled from the following sources:

  • Base Image:

    The Docker Hub is a service provided by Docker for finding and sharing container images. The images are some of the most secure images on Docker Hub and official released versions which can be used as a base image for usage.

  • gitlab.com:

    These are prebuilt images provided by gitlab.com to include jobs like static analysis.

  • Quay:

    A buildah image is provided by Red Hat (via Quay) to build custom container images. These images, which are used in later stages of the pipeline, are stored in the GitLab Registry.

• GitLab CI/CD:

  CI/CD is a GitLab feature which validates, request infrastructure for, and runs a GitLab pipeline using Container Registry.

  • GitLab pipelines:

    See Gitlab pipelines

  • Container Registry:

    This stores custom container images which are used by some pipeline jobs.

Architecture

The following diagram illustrates various components involved when the user raises a merge request for changes to be accepted for Project Cassini.

The different sections are described below:

• Pipeline configuration:

  This consists of further components:

  • Dangerfile:

    Configures and includes a danger-review job that is used to perform a variety of automated checks on the code under test.

    Danger is a Ruby Gem that runs in the CI environment. It only posts one comment and updates its content on subsequent danger-review runs.

  • .gitlab-ci.yml:

    The meta-cassini repository defines the configuration of pipeline, when user raises merge request for changes to be accepted.

  • Gitlab Templates:

    These provide templates when included for the project to enable/configure tools and functionalities for the pipelines which can be referred in GitLab Templates.

  • .codeclimate.yml:

    Configures Code Climate Plugin which is a Docker image that invokes a program that parses a config file and analyzes files, potentially producing formatted output representing issues in those files.

    Please refer related documentation in Code Quality .

• GitLab CI/CD:

  A brief overview can be found in GitLab pipeline.

  This consists of further components:

  • GitLab Runners:

    GitLab Runner is an application that works with GitLab CI/CD to run jobs in a pipeline.

  • Container Registry:

    The Container Registry holds the custom images required for specific pipeline jobs, which includes:

    • DangerBot Image

    • Code Climate plugins

    • FVP Image

    • IDT (IoT Device Tester) Greengrass Image

    • LAVA Test Image

    • Utility Image

• Testing:

  This consists of further components:

  • LAVA test framework:

    The LAVA provides the capabilities to test the built images for Cassini distribution on supported target platforms.

• Artifactory:

  This provides a database to store results from the LAVA test framework.