Skip to content

Latest commit

 

History

History
133 lines (102 loc) · 6.38 KB

README.md

File metadata and controls

133 lines (102 loc) · 6.38 KB
Raw

boom logo from http://pngtree.com/

Table of Contents

Overview

boom is a simple but opinionated command line interface providing options to emulate CI steps - either on your local development environment or on a cloud based CI provider. Currently it handles maven based projects and supporting docker commands to build, test, package a code base, generating docker images which are ready to be deployed to any cloud provider - GKE, Azure, AWS or private cloud hosted in your organization - using an orchestration provider like kubernetes of your choice.

boom is built using the Cobra, Viper package and golang

Installation

  • Run go get github.com/samirprakash/boom to install the latest version of this application

or

  • Clone github.com/samirprakash/boom to your $GOPATH
  • CD to the cloned repo
  • Run go install ./cmd/boom

Usage

Pre-requisites

boom assumes a few things to be in installed in your local build environment or on the remote build box, in order to execute the commands. Check that the below dependencies are satisfied.

  • Install maven
  • Setup maven with a valid settings.xml in ./m2 folder
  • Install docker
  • Do a docker login with your credentials

Available sub-commands

  • boom maven

    • execute maven based commands
    • use boom maven -h to check options and flags
    Usage:
  boom maven [command]

Available Commands:
  build       All in One - Validate, Compile, Clean, Unit test, Package, Code Coverage and Sonar
  clean       Cleans up your workspace
  deploy      Copies generated package to artifactory or nexus
  package     Packages your compiled code in a distributable format
  test        Executes unit tests facilitated with code coverage
  validate    Performs a validation and checks for compilation issues
  verify      Runs quality checks on integration test results

Flags:
  -h, --help   help for maven

    • boom maven build

      • validates and compiles the code base
      • cleans up the workspace
      • runs unit tests with JaCoCo code coverage plugin
      • packages the compiled code in the output as defined in pom.xml
      • runs and uploads sonar static analysis reports

    • boom maven validate

      • validates and compiles the code base

    • boom maven clean

      • cleans up the workspace

    • boom maven test

      • provides option to selectively execute integration tests or unit tests
      • with --integration-tests or -i flag executes the tests marked with a category integration-tests
      • with --unit-tests or -u flag executes the tests marked with a category unit-tests
      • without any flags executes all the tests which do not have a category defined

    • boom maven package

      • generates a JAR artifact from the code base
      • with --skip-test or -s flag provides an option to skip the test execution while packaging

    • boom maven verify

      • verifies the integration test results
      • should run after the code has been packaged and integration tests have been executed

    • boom maven deploy

      • deploys artifacts to remote repository such as artifactory or nexus
      • with flag --repository-id set to the string value of repository-id-configured-in-pom it uploads the artifact
      • authentication for remote repository needs to be configured beforehand by the user

  • boom docker

    • execute docker commands
    • use boom docker -h to check options and flags
    Usage:
boom docker [command]

Available Commands:
  build       Build docker images and push to a remote repository
  compose     Create docker compose environment based on the docker-compose.yaml in the code base
  tag         tag and push images to docker registry
  test        run collection of tests using newman command line runner

Flags:
  -h, --help   help for docker

    • boom docker build

      • builds a docker image based on a Dockerfile
      • as a default, needs to be executed from the folder which contains your Dockerfile
      • pushes the built image to a remote docker registry, only if the current branch is master or develop
      • with --image-tag or -i flag set to the value of the tag for the image will tag the image accordingly
      • with --app-type or -t flag set to the type of service i.e. - client/service/demo - would append this value to the tag

    • boom docker compose

      • configures any pre-requisites required for spinning up the docker containers
      • --repo-name or -r can be used to clone the config-source repo locally by providing the repository name as an entry to this flag
      • spins up a docker compose environment based on the provided docker compose file as a entry for the flag --compose-file or -f
      • checks the health status of the docker containers based on the ports that have been exposed which can be provided to the command as a comma seperated string i.e. 9090,9091,9092......9099 to the flag --helthcheck-ports or -p

    • boom docker clean

      • stops any containers currentnly running which were started by the docker compose command
      • cleans up the stopped containers from docker environment providing a clean build environment

    • boom docker test

      • executes newman tests on the docker compose environment
      • with flag --network-bridge or -n set to the default network for this compose environment. This value can be found out using docker network ls
      • with the flag --test-collection or -c set to the test collection
      • with the flag --environment-spec or -e set to the container environment

    • boom docker tag

      • tags and pushes the images generated by the docker compose environment to a remote docker registry
      • with flag --current-image or -i set to the current image which needs to be tagged as per remote docker registry requirements
      • with flag --new-image or -n set to the new tag that we want to the tag the image with