Look mom no TravisCI

Look mom no TravisCI

May 15, 2022

Back to blogging again I'm learning golang and so I decided to create a simple CI platform.

πŸ›Έ What is Hermes ?

Hermes is the winged herald and messenger of the Olympian gods. In addition, he is also a divine trickster, and the god of roads, flocks, commerce, and thieves. ... Hermes was the only Olympian capable of crossing the border between the living and the dead.

Ohh nope not that ...

Hermes CI (CI stands for Continuous integration) is an open-source continuous integration platform mainly written in Go.

The main idea is to clone the core feature of TravisCI means to run a pipeline in a code repository and save logs and build status whenever a developer performs a registered event (push, PR, merge ...)

🚦Continuous integration (Back to school)

Continuous integration is a DevOps software development practice where developers regularly merge their code changes into a central repository, after which automated builds and tests are run β€” AWS

Breaking down the solution:

So the idea is to create a process of transit of the code from developers' machines to production servers automatically. And as git is become the defacto standard of version control.I will be using Github webhooks to capture the developer's events on the code.

βš™ Config file:

It's a simple config file to tell the backend the type of job to schedule. This PoC support only Dockerized application ( app with docker file)

Hermes.yaml

name: My super pipeline
version: 1.0.0
schema: docker

Dockerfile 🐳

A classic Dockerfile with instructions to be executed by buildh. in this example I used a very simple one

FROM yauritux/busybox-curl

RUN echo "Running build"
RUN echo "We don't need to build anything"
RUN echo "Getting Ouarzazate weather"
RUN echo "weather is goood"

πŸ’… Frontend :

Simple nuxt.js application allow the user to authenticate using Github's OAuth and get the list of public repositories.

β”œβ”€β”€ README.md
β”œβ”€β”€ commitlint.config.js
β”œβ”€β”€ components
β”‚Β Β  β”œβ”€β”€ NuxtLogo.vue
β”‚Β Β  └── Tutorial.vue
β”œβ”€β”€ jest.config.js
β”œβ”€β”€ layouts
β”‚Β Β  └── default.vue
β”œβ”€β”€ middleware
β”‚Β Β  └── authenticated.ts
β”œβ”€β”€ nuxt.config.js
β”œβ”€β”€ package.json
β”œβ”€β”€ pages
β”‚Β Β  β”œβ”€β”€ index.vue
β”‚Β Β  β”œβ”€β”€ login.vue
β”‚Β Β  └── repos
β”‚Β Β      β”œβ”€β”€ _id
β”‚Β Β      β”‚Β Β  β”œβ”€β”€ index.vue
β”‚Β Β      β”‚Β Β  └── job
β”‚Β Β      β”‚Β Β      └── _job.vue
β”‚Β Β      └── index.vue
β”œβ”€β”€ static
β”‚Β Β  └── favicon.ico
β”œβ”€β”€ store
β”‚Β Β  β”œβ”€β”€ README.md
β”‚Β Β  β”œβ”€β”€ index.md
β”‚Β Β  └── index.ts
β”œβ”€β”€ stylelint.config.js
β”œβ”€β”€ test
β”‚Β Β  └── NuxtLogo.spec.js
β”œβ”€β”€ tsconfig.json
β”œβ”€β”€ types
β”‚Β Β  └── index.ts
└── yarn.lock

The magic happens when the user chooses a repository and configures it with Hermes CI (basically creating a webhooks on the repository's end (Github) to listen to Push, Pull request event)

    createHook() {
      try {
        this.$axios.post(
          `${process.env.gitHubUrl}repos/${this?.user?.login}/${this?.id}/hooks`,
          {
            name: 'web',
            active: true,
            events: ['push', 'pull_request'],
            config: {
              url: `http://hermes.soubai.me/github/${this?.repo?.id}`,
              content_type: 'json',
              insecure_ssl: '0',
              digest: 'Hermes',
            },
          },
          {
            headers: {
              Accept: 'application/vnd.github.v3+json',
            },
          }
        )
      } catch (error) {
        console.log(error)
      }
    },

Additionally, the frontend allows the user to track the build status and read the logs (fetching from the backend)

πŸ¦€ Backend

β”œβ”€β”€ LICENSE
β”œβ”€β”€ Makefile
β”œβ”€β”€ go.mod
β”œβ”€β”€ go.sum
β”œβ”€β”€ main.go
β”œβ”€β”€ models
β”‚Β Β  └── Job.go
β”œβ”€β”€ readme.md
β”œβ”€β”€ server.service
└── tmp

A Golang HTTP server application to handle the request sent by Github whenever a registered event is triggered by user actions ex. push, pull_request. The backend uses the payload as context to create a job and schedule it in a queue message. Besides that, the backend saves status, logs, and jobs in MongoDB so we can read asynchronous operations in the frontend later.

http server


	router.HandleFunc("/github/{id}", handleGitHubWebhook).Methods("POST")
	router.HandleFunc("/github/{id}", GetJobs).Methods("GET")
	router.HandleFunc("/jobs/{id}", GetJob).Methods("GET")

	err := http.ListenAndServe(":"+os.Getenv("PORT"), corsOpts.Handler(router))
	if err != nil {
		log.Fatal(err)
	}

I use Async as a message queue that uses Redis internally as a database in memory; The main goal of using Async is the classic use case of a message queue: optimize job requests load and decoupling a backend APIs part from the job Runner.

func JobProcessingTask(id string, body Payload) (*asynq.Task, error) {
    payload, err := json.Marshal(JobPayload{ID: id, Body: body})
    if err != nil {
        return nil, err
    }
    return asynq.NewTask(TypeJobProcessing, payload), nil
}

πŸƒ Runner

β”œβ”€β”€ Makefile
β”œβ”€β”€ go.mod
β”œβ”€β”€ go.sum
β”œβ”€β”€ install.sh
β”œβ”€β”€ main.go
β”œβ”€β”€ models
β”‚Β Β  └── Job.go
β”œβ”€β”€ readme.md
└── tmp

The runner is an application that works with pipelines. A pipeline is a list of instructions/commands supposed to be executed by this runner as a single isolated process. In our case, the job is the pipeline defined in a Dockerfile inside the user's Github repository.

So basically runner's role is to :

  1. Pull the user's repository code from Github
  2. Run Dockerfile using buildah
  3. Catch build logs
  4. Save everything in MongoDB database
ctx := context.Background()
cmd = exec.CommandContext(ctx, "buildah", "bud", "--log-level", "info", "-t", strings.ToLower(body.Repository.FullName), path)
stdout, err := cmd.StdoutPipe()
cmd.Stderr = cmd.Stdout

πŸ“‹ Sum up

HermesCI is a PoC of how we can make a CI system at home and gives me a great way to learn about all those concepts. you can find the code publicly here buildah

Cheers


Profile

Written by Abderrahim SOUBAI-ELIDRISI A Homosapien with affinity to machines. Interested in Web Technologies & Cloud Follow him on twitter