Skip to content

Latest commit

 

History

History
85 lines (55 loc) · 2.04 KB

developing.md

File metadata and controls

85 lines (55 loc) · 2.04 KB
Raw

Developing Cincinnati

Overview

The following sections describe how to build and test the project for local development.

Prerequisites

Note: We recommend using Rustup for Rust toolchain management.

Running it locally

Run below commands in parallel (for e.g. in different terminals at the same time).

just run-graph-builder
just run-policy-engine

Requesting the graph from the local instance

$ just get-graph-pe can be run to get the graph from a local policy-engine instance. For example, to get the graph for the "stable-4.2" channel and the "amd64" architecture, run:

just get-graph-pe "stable-4.2" "amd64"

If you would like to visualize the result you can pipe the result through the display-graph recipe as follows:

just get-graph-pe "stable-4.2" "amd64" | just display-graph

To get the graph from a local graph-builder instance, run:

just get-graph-gb

Note: The graph-builder doesn't consider any request parameters right now, so passing channel, architecture, or others would have no effect.

Running tests locally

Unit tests

just test

CI tests

just run-ci-tests

To run test with net-private

These tests need secrets which can not be shared publicly at this point. We will provide a solution fix this in the future. Until then, please rely on the CI to run these tests for each pull request.

If you have access to the secrets, the following environment variables need to be set before running the tests.

  • CINCINNATI_TEST_CREDENTIALS_PATH
  • CINCINNATI_TEST_QUAY_API_TOKEN_PATH
  • CINCINNATI_TEST_QUAY_API_TOKEN

Example:

export CINCINNATI_TEST_CREDENTIALS_PATH="$PWD/.ci_credentials/docker.config.json"
export CINCINNATI_TEST_QUAY_API_TOKEN_PATH="$PWD/.ci_credentials/api_access_token"
export CINCINNATI_TEST_QUAY_API_TOKEN="$(cat $PWD/.ci_credentials/api_access_token)"
just test-net-private