Skip to content

Latest commit

 

History

History
176 lines (112 loc) · 6.58 KB

README.md

File metadata and controls

176 lines (112 loc) · 6.58 KB
Raw

The CI gem helps to perform CI capability in the minimalistic approach

CI is a gem to say consume the Quay.io posts on sucessful build completion and perform the docker operations and tests run or say perform the CI capability.

Lets say a developer checks in the code to the github. The container repository like Quay receives a call to perform the operations on building the new say Docker repo and host it. Quay can be later configured to be able to shoot out a POST call when this is done. Such call is consumed by the continuous_integration to be able to perform customized operations. Like say, destroy the local or old docker container(s). Pull the latest container(s) from the Quay. Pull the latest API or UI tests and run them against the new container(s). Finally report the test run results to the team on Slack or wherever.

History

The idea came into picture when trying to leverage the right CI tool to help run the automated API or the UI tests. Having traversed the various industry standard CIs it was thought to anyway have a light weight CI server to help achieve the same.

Installation and usage

To install (or update to the latest version) using the bundler gem. Add this line to your application's Gemfile:

gem 'continuous_integration'

then run

bundle install

To install directly (without bundler), run

gem install continuous_integration

Usage

Pre-requisites

  1. Make sure that Docker and Aha tool are installed
  2. The Paths in the constants.rb file should be valid
  3. The user may need sudo access as docker needs them

Constants

Default paths have been defined in the constants.rb file. Update it aqccordingls as per your needs. It can also be overriden by passing them when running the server env var.

DOCKER_PATH is the path to your repo containing the docker-compose.yml file having all the services defined in it

NOTE: Paths must be valid for the CI to work correctly

Running

In a console just run

$ continuous_integration

Running as a program

Put the below contents in a ruby file say ci_server.rb

#ci_server.rb

require 'continuous_integration'
ContinuousIntegration::Server.start_server

and then run it like below to start the CI server

ruby ci_server.rb

You should be able to receive the POST requests on http://localhost:8080/ now

Also, if you access the above URL in a browser, it shows you the content of the API_SPECS_PATH/logs as a web server, which apparently happens to be the path of the api test tun logs generated by the aha tool

POSTing to the server

This curl should POST the sample Quay successful completion json to the CI

curl -d "@schemas/quay-success-completed.json" -H "Content-Type: application/json" -X POST http://localhost:8080/qa/docker

Stopping the server

Ctrl + C

OR

ContinuousIntegration::Server.shutdown_server

Results

Test results should be available in the API_SPECS_PATH/logs folder which can be accessed by the browser at http://localhost:8080/

Furthermore code can be added ini slack_post method tasks.rbtasks.rb to send this test results link to your team on a slack channel

Troubleshooting

For help with common problems, see TROUBLESHOOTING.

Still stuck? Try filing an issue.

Other questions

To see what has changed in recent versions of CI, see the CHANGELOG.

To get in touch with the ContinuousIntegration core team and other CI users, please see getting help.

Contributing

If you'd like to contribute to ContinuousIntegration, that's awesome, and we <3 you. There's a guide to contributing to ContinuousIntegration (both code and general help) over in our documentation section.

To - Do list

  1. Create text file say PATHFILE when installing gem to easy fill in the constants rather than be in the code
  2. Add more container hosting providers support and add tasks accordingly
  3. Segregate individual tasks like tests run more seamlessly or even make them file based to give more flexibillity

Code of Conduct

Everyone interacting in the CI project’s codebases, issue trackers, chat rooms, and mailing lists is expected to follow the CI code of conduct.

Acknowledgments

Docker

Quay

Aha tool

Customizations

Depending on the need and various third party services customizations, please feel free to write to me

Contributing

  1. Fork it
  2. Make sure you init the submodules (git submodule init && git submodule update)
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request

Release process

Check the circle.yml for the latest, but currently merging to master will build and deploy to the following Equinox channels:

Tag Channels
No tag dev
vX.Y.Z-alpha.N or vX.Y.Z-beta.N beta, dev
vX.Y.Z stable, beta, dev

Development + release process is:

  1. Branch from master
  2. Do work
  3. Open PR against master
  4. Merge to master
  5. Branch from master to update CHANGELOG.md to include the commit hashes and release date
  6. Update the version constant in rainforest-cli.go following semvar
  7. Merge to master
  8. Tag the master branch with the release:
   git tag vX.Y.Z or vX.Y.Z-alpha.N or vX.Y.Z-beta.N
   git push origin vX.Y.Z
  1. Merge to master to release to stable/beta/dev
  2. Add release to Github release page

Donations

If you are using CI for you organization, please help solicit to donate, as this work is made possible with donations like yours. It involves years of efforts with money spent to obtain the college degree and experience gained to write quality software. PM for customizations and implementations.

paypal