Skip to content

devops

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

devops

README.md

Libsovtoken devops routine

This folder includes devops related routine and consists of the following parts:

  • Makefile automates devops tasks like test, package and publish to crates.io which could be performed either on-host or in-docker
  • docker folder holds docker related routine
  • aws-codebuild folder consists of files that describes AWS CodeBuild based CI/CD pipelines
  • ext folder is a git-subrepo of shared library which provides makefile based approach of devops tasks automation. Please check its README.md for more information.

Docker

Aurora wallet is shipped with dockerfiles for ubuntu xenial and centos7 which describe images with necessary environment for CI/CD tasks on these OSes.

CI pipeline

CI pipeline is described by Jenkinsfile.ci. It uses Jenkins shared library API to build projects on AWS CodeBuild. CI utilizes docker containers from docker/ci folder to run tests on both ubuntu xenial and centos7.

CI pipeline stages:

  • clone the GitHub repository
  • upload current HEAD as zip archive to AWS S3 bucket used by CodeBuild project
  • launch a CodeBuild project using AwsCodeBuildHelper.build API. It includes a set of sub-stages:
    • (optional) create/update the CodeBuild project
    • (optional) create an AWS ECR repository to use by CodeBuild project
    • (optional) build docker image and push it to the AWS ECR repository
    • run the CodeBuild project to perform cargo testing
    • download logs
  • archive logs

CD pipeline

CD pipeline is described by Jenkinsfile.cd. It uses Jenkins shared library API as well and generates the following artifacts:

  • debian package for ubuntu xenial
  • zip archive with shared and dynamic libraries for android on the following architectures: arm, armv7, arm64, x86, x86_64

CD pipeline stages:

  • clone the GitHub repository
  • resolve the following parameters:
  • evaluate new debian package version basing on source version, last revision number and current build number
  • upload current HEAD as zip archive to AWS S3 bucket used by CodeBuild project
  • launch a CodeBuild project using the same AwsCodeBuildHelper.build API as CI does. The main difference here is that CD pipeline doesn't build an image for AWS ECR repository assuming that it has been done previously by CI pipeline. Its sub-stages:
    • (optional) create/update CodeBuild project (TODO shouldn't do that in any case assuming CI did that)
    • run the CodeBuild project to perform debian packaging
    • download logs
  • archive logs
  • upload created debian package to Sovrin debian repo

Makefile

Requirements

  • make
  • docker
  • docker-compose

Targets

Please refer to ext/README.md for more details about targets inherited from there.

General build targets

  • test_dry runs tests in "dry" mode: cargo test --no-run
  • test runs tests: cargo test
  • build runs cargo build
  • publish_crate publishes the code to crates.io performing cargo login, package and publish commands
  • package creates debian package
  • package_android builds and archives libraries for android for a set of architectures

Each target could be run in two ways - with or without _in_docker postfix: e.g. test_in_docker and test. In former case the target is run inside docker container, otherwise current host's environment is used. Docker image for each target can be built using image_<build-target-name> target.

Android build target

  • android_build_<arch> builds libraries for android, where arch is one of supported platforms (please check ANDROID_ARCHS environment variable to see the list of supported platforms).

Docker images targets

  • image_<build-target-name> - set of targets to build docker images for general build targets in-docker running
  • image_lst_base builds docker image with necessary environment to create debian package, it's a parent for image_lst_ci image
  • image_lst_base_version prints current version of the docker image (dockerfile) built by image_lst_base target
  • image_lst_ci builds docker image with necessary environment to perform CI tasks
  • image_lst_ci_version prints current version of the docker image (dockerfile) built by image_lst_ci target

Environment variables

Variable Targets Description Default
PROJECT_DIR all absolute path of the top level project dir resolved as git rev-parse --show-toplevel
RELEASE all adds --release flag to cargo test and build commands if set to 1 1
OSNAME all switches OS context, possible values: xenial, centos7 xenial
CARGO_TARGET_DIR all sets CARGO_TARGET_DIR environment variable target/$(OSNAME)
ANDROID_ARCHS package_android target architectures for android builds arm, armv7, arm64, x86, x86_64
CRATE_P_VERSION all if set overwrites version field of [package] section in Cargo.toml before crate publishing not set
CARGO_LOGIN_TOKEN all token to perform cargo login during crate publishing not set
DOCKER_NAME all name of the image built by image_lst_ci target sovrin/libsovtoken
DOCKER_TAG all tag of the image built by image_lst_ci target <VERSION>-$(OSNAME)-ci, where VERSION is value of CI_ENV_VERSION environment variable in accordant dockerfile

Please refer to ext/README.md for list of environment variables inherited from there