README.md

Continuous Integration (CI) System

Step Runner

A go program that simulates a build server. To run it, you can:

• Run with docker (Recommended):

  docker build -t ci-system . && docker run -it -p 8080:8080 ci-system

• Run locally in the root directory of this project:

  go run main.go

You can control the server address with the STEP_RUNNER_SERVER_ADDR environment variable, by default it will be :8080 .

API documentation

How to use it? The server has a single endpoint, here's an example:

# Test the POST endpoint
curl -X POST http://localhost:8080/step/trigger \
     -H 'Content-Type: application/json' \
     -d '{
           "step_name": "lint",
           "repo_path": "/some/path/to/local/repo",
           "commit_hash": "1234567890"
         }'

There can be three steps in step_name : lint , build , and test .

• The lint step will always succeed and can run in parallel.
• The build step might succeed and might fail, and can't run in parallel with other builds.
• The test step might succeed and might fail, can't run in parallel with other tests, and MIGHT crash the server.

Notes

The server is intentionally unstable to simulate the real experience of working with a CI pipeline that may occasionally fail or crash.

CI Server

The CI server watches a local git repo and uses the step runner to run lint , build , and test on every commit.

To run the CI server, run the following command:

poetry install
poetry run python ci_server.py "/some/path/to/local/repo" ":8080"

Endpoints

These endpoints are part of the CI Server to manage and view the CI runs and their statuses.

For a more interactive experience, visit:

http://0.0.0.0:9000/docs

Get All CI Runs

Retrieve a list of all CI workflow runs with their commit hashes and status.

GET /runs

Response body:

{
  "total": 2,
  "data": [
    {
      "id": "e7d326e98add46f08f713c1829d29b01fb926c58",
      "status": "success"
    },
    {
      "id": "475249b294a48bf509c6ef36d9c3e52370b33f0b",
      "status": "failure",
      "failed_steps": [
        "build",
        "test"
      ]
    }
  ]
}

Get CI Run Details by Commit Hash

Retrieve the details of a specific CI run by providing its commit id.

GET /run/{commit_hash}

Replace {commit_hash} with the actual commit id to get the details of that particular CI run.

Example Request: /run/e34157851e

Response body:

{
  "id": "e34157851e",
  "status": "failure",
  "failed_steps": [
    "test"
  ]
}