continuous_integration 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8f963aefeb43fef87407dbed44b56ba9344a65f
-  data.tar.gz: ece5f7b447d5dc0f3b64f6f4a2d27b1a1ef19820
+  metadata.gz: bd54be966578be56bbab0d6b71521c704586205c
+  data.tar.gz: e59248652de2a1e53531ce5c6b863ec7f6f05876
 SHA512:
-  metadata.gz: cc13454449f1d1bbda2ca823a52618c5b696c9c1feded8df466ebb1536f794b2ab68a99b32327caa91a5f7eee1a0fd9180dc18cb55bcb7cd6551ac237725afbc
-  data.tar.gz: 3aa212a777cf4b27d3f4fe21c427a2d03497f03d08805a327c9a979b154ed84167dd32a70a4a92583d356e045292d1a7aa8f25348dad3a8cfee40992b5fc981e
+  metadata.gz: f98a5368bc90bf9e1f564be0e17fb154c2b9354194388d8c1839e61603b1e2b509db8a50f69666d6909e354b8c1f6f9c37ef5135d1af97202437503dc5c10729
+  data.tar.gz: 4c6cb62303950dbb5aa9e78dcd87c8b2932eeeca6013c172585feb1bc1d255181c7301c4aafb366cc32e290d3a0375c6c2ab2122dbb6b0d6f1b3a1a382b16cee

data/README.md

@@ -1,27 +1,91 @@
-# continuous_integration
+# The CI gem helps to perform CI capability in the minimalistic approach 
 
-## Installation
+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.
 
-Add this line to your application's Gemfile:
+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'
+```
 
-And then execute:
+then run
 
-$ bundle
+```
+bundle install
+```
 
-Or install it yourself as:
+To install directly (without bundler), run
 
-$ gem install continuous_integration
+```
+gem install continuous_integration
+```
 
 ## Usage
 
-Starting the server
-```ruby
+Put the below contents in a ruby file say `ci_server.rb`
+
+```
+require 'continuous_integration'
 server = ContinuousIntegration.run_ci
+server.start
 ```
 
+and 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 
+
 Shutting it down
-```ruby
-ContinuousIntegration.shutdown_server server
 ```
+Ctrl + C
+```
+
+## Paths
+
+Default paths have been updated in the [constants.rb](lib/continuous_integration/constants.rb) file. It can be overriden by passing env vars when running the server.
+
+## 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
+
+### Troubleshooting
+
+For help with common problems, see [TROUBLESHOOTING](doc/TROUBLESHOOTING.md).
+
+Still stuck? Try [filing an issue](doc/contributing/ISSUES.md).
+
+### Other questions
+
+To see what has changed in recent versions of Bundler, see the [CHANGELOG](CHANGELOG.md).
+
+To get in touch with the ContinuousIntegration core team and other Bundler users, please see [getting help](doc/contributing/GETTING_HELP.md).
+
+### 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](doc/README.md).
+
+
+#### Donations
+
+Please feel free 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](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZKRHDCLG22EJA)
+
+### 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](doc/CODE_OF_CONDUCT.md).

data/continuous_integration.gemspec

@@ -10,7 +10,8 @@ Gem::Specification.new do |gem|
 	gem.email         = ["ragavendra.bn@gmail.com"]
 	gem.description   = %q{CI server for running integration tests using webrick}
 	gem.summary       = %q{One can run their UI and API tests using this gem}
-	gem.homepage      = ""
+	gem.homepage      = "https://rubygems.org/gems/continuous_integration"
+	gem.license       = 'MIT'
 
 	gem.files         = `git ls-files`.split($/)
 	gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -18,5 +19,5 @@ Gem::Specification.new do |gem|
 	gem.require_paths = ["lib"]
 
 	gem.add_development_dependency 'rspec', '~> 2.7'
-	gem.add_development_dependency 'rake'
+	gem.add_development_dependency 'rake', '~> 0'
 end

data/lib/continuous_integration/tasks.rb

@@ -3,8 +3,6 @@ require_relative 'constants'
 class DockerEndpoint < WEBrick::HTTPServlet::AbstractServlet
 
 	def initialize param
-		#def initialize(opts)   
-		#super(opts)    
 		@resourcePath = "/cards"       
 		@repo_name = ''
 		@process_status = ''
@@ -17,46 +15,21 @@ class DockerEndpoint < WEBrick::HTTPServlet::AbstractServlet
 
 
 	#curl localhost:8080/docker
-	def do_GET (request, response)
-
-		#status, content_type, body = do_stuff_with request
-		response.status = 200
-		response['Content-Type'] = 'text/plain'
-		response.body = 'Hello, World!'
-
-		puts "this is a get request"
-		#puts "Dir - #{root}"	
-		#puts "Dir - #{File.expand_path '/home/raga/gitbase/test-auto/SOA/api/log/'}"	
-
-		obj = {
-			"TIME" => Time.now.strftime("%FT%T"),
-			"foo" => "Test",
-			"bar" => "QA-Automation",
-			'a' => 2,
-			'b' => 3.141,
-			'COUNT' => 1,
-			'c' => 'c',
-			'd' => [ 1, "b", 3.14 ],
-			'e' => { 'foo' => 'bar' },
-			'g' => "Ragu's response",
-			'h' => 1000.0,
-			'i' => 0.001,
-			'j' => "\xf0\xa0\x80\x81",
-		}
-		response.body = JSON.generate obj
-		response['Content-Type'] = "application/json"
-	end
-
+	#POST call made by quay to CI server
 	def do_POST (request, response)
 
+		#parse JSOn to hash key
 		requestHash = JSON.parse(request.body, symbolize_names: true)
+		
+		#fetch the github repo name
 		@repo_name = requestHash[:name]
 
+		#fetch the github branch name
 		@git_branch = requestHash[:trigger_metadata][:ref]
 		@git_branch = @git_branch.split('/')
 		@git_branch = @git_branch.last
 
-		#handle requests one at a time - Needs testing
+		#handle requests one at a time (to avoid concurrency) - Needs testing
 		while @lock 
 			@lock = true
 			docker_update
@@ -70,6 +43,7 @@ class DockerEndpoint < WEBrick::HTTPServlet::AbstractServlet
 		end
 	end	
 
+	#update docker images locally
 	def docker_update
 		Dir.chdir(DOCKER_PATH){
 			#perform docker images update
@@ -80,11 +54,13 @@ class DockerEndpoint < WEBrick::HTTPServlet::AbstractServlet
 
 	end
 	
+	#Action - run api tests
 	def run_api_tests
 		Dir.chdir(API_SPECS_PATH){
-			cmd = "RUBYOPT='-W0' HOST=#{HOST} RMQ_HOST=#{HOST} RMQ_VHOST=/ bundle exec rake cards:#{@git_branch} | aha --black >logs/#{@git_branch}/$(date +\%d-\%m-\%Y-\%H-\%s)-API-run.htm"
-			@result_api = %x[#{cmd}]
-			#%x["bundle exec rake cards:dev | aha --black >$LOGPATH/$(date +\%d-\%m-\%Y-\%H-\%s)-run.htm"]
+			#shell command to run my tests using rake . I am using `aha` shell tool to grab shell output to html
+			cmd = "RUBYOPT='-W0' HOST=#{HOST} RMQ_HOST=#{HOST} RMQ_VHOST=/ bundle exec rake cars:#{@git_branch} | aha --black >logs/#{@git_branch}/$(date +\%d-\%m-\%Y-\%H-\%s)-API-run.htm"
+			@result_api = %x[#{cmd}] 
+			# or use ` .... ` instead of %x[ .... ] to run commands
 		}
 	end
 	
@@ -97,7 +73,6 @@ class DockerEndpoint < WEBrick::HTTPServlet::AbstractServlet
 	end
 
 	def generate_log
-	
 		obj = {
 			"Docker logs" => @process_status,
 			"API logs" => @result_api,
@@ -112,4 +87,44 @@ class DockerEndpoint < WEBrick::HTTPServlet::AbstractServlet
 	end
 end
 
-
+#Below is the POST from Quay.io, parse and use the necessary data
+=begin
+
+{
+  "repository": "mynamespace/repository",
+  "namespace": "mynamespace",
+  "name": "repository",
+  "docker_url": "quay.io/mynamespace/repository",
+  "homepage": "https://quay.io/repository/mynamespace/repository/build?current=some-fake-build",
+  "visibility": "public",
+
+  "build_id": "build_uuid",
+  "docker_tags": ["latest", "foo", "bar"],
+
+  "trigger_kind": "github",                                       // Optional
+  "trigger_id": "some-id-here",                                   // Optional
+  "trigger_metadata": {                                           // Optional
+    "default_branch": "master",
+    "ref": "refs/heads/somebranch",
+    "commit": "42d4a62c53350993ea41069e9f2cfdefb0df097d",
+    "commit_info": {                                              // Optional
+      "url": "http://path/to/the/commit",
+      "message": "Some commit message",
+      "date": 2395748365,
+      "author": {                                                 // Optional
+        "username": "fakeauthor",
+        "url": "http://path/to/fake/author/in/scm",               // Optional
+        "avatar_url": "http://www.gravatar.com/avatar/fakehash"   // Optional
+      },
+      "committer": {                                              // Optional
+        "username": "fakecommitter",
+        "url": "http://path/to/fake/comitter/in/scm",             // Optional
+        "avatar_url": "http://www.gravatar.com/avatar/fakehash"   // Optional
+      }
+    }
+  }
+}
+
+More info here -> http://docs.quay.io/guides/notifications.html#webhook_build_success
+
+=end

data/lib/continuous_integration/version.rb

@@ -1,3 +1,3 @@
 module ContinuousIntegration
-	VERSION = "0.0.3"
+	VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: continuous_integration
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ragavendra Nagraj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -28,14 +28,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: CI server for running integration tests using webrick
@@ -56,8 +56,9 @@ files:
 - lib/continuous_integration/constants.rb
 - lib/continuous_integration/tasks.rb
 - lib/continuous_integration/version.rb
-homepage: ''
-licenses: []
+homepage: https://rubygems.org/gems/continuous_integration
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []