continuous_integration 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f75d10fd59e010dda9a142a74190ee0c5f26c7f6
-  data.tar.gz: b87b23690db9f76e9cf8542feb65480310e4e4ff
+  metadata.gz: 35bdfc28e10f4f15fe3d01a267dabd5d910238a3
+  data.tar.gz: d8e6515cac9a97932f2c1263928fd8ef430b071e
 SHA512:
-  metadata.gz: afe3ca1c56ef73bc6b8c0714f1531d52ffbf936a48ccd6409df38b88a4ddef970958549786a2669a55677172d80bdd049ca9c957eff491669edf4a6608ef7e6c
-  data.tar.gz: 7f52043f6193d397ed84fb9a6520ebd4d5b2bc5ff17d03a5afe75349340727ee991b15b9616735d32a00119c6c6fcd32a4117c47cc4da36805952bc0571bbeb9
+  metadata.gz: bf93d80e13b875f6a9908df1156b566835a32bd0b050790d11793eeca41139edb7a946b1a0678b8e002cdc52f21f844e5cb7d97e5757ef2f9cea2a6285eeb669
+  data.tar.gz: 99ff295ba9bcfe266f4984e5f0ab1cccef0391739d96edfedf260715a93ab11f74cb4d865ab8cb120c5485dc4eebdeae5105e6fdb6d9f6008125d10a4c3d087d

data/.gitignore

@@ -15,3 +15,8 @@
 *.swp
 *.swo
 *.jpg
+
+#bundler files
+Gemfile
+Gemfile.lock
+.ruby-version

data/README.md

@@ -35,8 +35,15 @@ gem install continuous_integration
 Default paths have been defined in the [constants.rb](lib/continuous_integration/constants.rb) file. Update it aqccordingls as per your needs. It can also be overriden by passing them when running the server env var.
 
 #### Running
-Put the below contents in a ruby file say `ci_server.rb`
+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
 
@@ -85,6 +92,17 @@ If you'd like to contribute to ContinuousIntegration, that's awesome, and we <3
 
 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).
 
+#### Acknowledgments
+[Docker](https://www.docker.com/)
+
+[Quay](https://quay.io/)
+
+[Aha tool](https://github.com/theZiz/aha)
+
+
+#### Customizations
+Depending on the need and various third party services customizations, please feel free to write to me
+
 ### 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 

data/Rakefile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-	  t.libs << 'test'
+  t.libs << 'test'
 end
 
-desc "Run tests"
-task :default => :test
+desc 'Run tests'
+task default: :test

data/bin/continuous_integration

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'continuous_integration'
 

data/continuous_integration.gemspec

@@ -1,23 +1,29 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'continuous_integration/version'
 
 Gem::Specification.new do |gem|
-	gem.name          = "continuous_integration"
-	gem.version       = ContinuousIntegration::VERSION
-	gem.authors       = ["Ragavendra Nagraj"]
-	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      = "https://rubygems.org/gems/continuous_integration"
-	gem.license       = 'MIT'
+  gem.name = 'continuous_integration'
+  gem.version       = ContinuousIntegration::VERSION
+  gem.authors       = ['Ragavendra Nagraj']
+  gem.email         = ['ragavendra.bn@gmail.com']
+  gem.description   = 'CI server for running integration tests using webrick'
+  gem.summary       = 'One can run their UI and API tests using this gem'
+  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) }
-	gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-	gem.require_paths = ["lib"]
+  # gem.files         = `git ls-files`.split($/)
+  gem.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  # gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.bindir = 'bin'
+  gem.executables   = ['continuous_integration']
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
 
-	gem.add_development_dependency 'rspec', '~> 2.7'
-	gem.add_development_dependency 'rake', '~> 0'
+  gem.add_development_dependency 'minitest', '~> 5.0'
+  gem.add_development_dependency 'rake', '~> 0'
 end

data/lib/continuous_integration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'webrick'
 require 'json'
 include WEBrick
@@ -6,47 +8,61 @@ require 'continuous_integration/constants'
 require 'continuous_integration/tasks'
 require 'continuous_integration/version'
 
+# Module to perform CI operations!
 module ContinuousIntegration
+  # Perform Continuous Integration operations!
+  #
+  # Example:
+  #   >> server = ContinuousIntegration.setup_server
+  #   >> ContinuousIntegration.start_server server
+  #   => INFO  WEBrick x.x.x
+  #
+  # Arguments:
+  #   server: (Object)
+
+  # setup the CI server config
+  def self.setup_server
+    # path for the web server to serve the test results
+    root = File.expand_path "#{API_SPECS_PATH}/logs"
+
+    # create the server
+    server = create_server root
+
+    # mount the dir
+    dir_mount server
+
+    # shut server down on any interrupt
+    trap('INT') do
+      shutdown_server server
+    end
+
+    server
+  end
+
+  def self.start_server(server)
+    server.start
+  end
+
+  def self.shutdown_server(server)
+    dir_unmount server
+    server.shutdown
+  end
+
+  private_class_method
+
+  def self.create_server(root)
+    WEBrick::HTTPServer.new(
+      Port: PORT_NUM,
+      DocumentRoot: root,
+      DirectoryIndex: []
+    )
+  end
+
+  def self.dir_mount(server)
+    server.mount SUB_URI, DockerEndpoint
+  end
 
-	#setup the CI server config
-	def self.setup_server
-		#path for the web server to serve the test results
-		root = File.expand_path "#{API_SPECS_PATH}/logs" 
-		
-		#create the server
-		server = create_server root
-
-		#mount the dir
-		dir_mount server
-		
-		#shut server down on any interrupt
-		trap("INT") {
-			shutdown_server server
-		}
-
-		return server
-	end
-	
-	def self.start_server server
-		server.start
-	end
-	
-	def self.shutdown_server server
-		dir_unmount server 
-		server.shutdown
-	end
-
-	private
-
-	def self.create_server root
-		WEBrick::HTTPServer.new :Port => PORT_NUM, :DocumentRoot => root, :DirectoryIndex  => []
-	end
-	
-	def self.dir_mount server
-		server.mount SUB_URI, DockerEndpoint
-	end
-
-	def self.dir_unmount server
-		server.unmount SUB_URI
-	end
+  def self.dir_unmount(server)
+    server.unmount SUB_URI
+  end
 end

data/lib/continuous_integration/constants.rb

@@ -1,14 +1,16 @@
-#this file is like the global variable file
+# frozen_string_literal: true
+
+# this file is like the global variable file
 
 DOCKER_PATH = "#{ENV['HOME']}/repos/devops/services/soa/dev"
 API_SPECS_PATH = "#{ENV['HOME']}/repos/api_tests"
 UI_SPECS_PATH = "#{ENV['HOME']}/repos/selenium_tests"
 
-HOST = "dockervm"
-#HOST="https://amzn-se001"
-#HOST="https://qa.hostname.ca"
-BROWSER = "phantomjs"
+HOST = 'dockervm'
+# HOST="https://amzn-se001"
+# HOST="https://qa.hostname.ca"
+BROWSER = 'phantomjs'
 SCREENS = true
 
 PORT_NUM = 8080
-SUB_URI = "/qa/docker/"
+SUB_URI = '/qa/docker/'

data/lib/continuous_integration/tasks.rb

@@ -1,130 +1,137 @@
+# frozen_string_literal: true
+
 require_relative 'constants'
 
+# Class to perform operations on receiving http calls
 class DockerEndpoint < WEBrick::HTTPServlet::AbstractServlet
-
-	def initialize param
-		@resourcePath = "/cards"       
-		@repo_name = ''
-		@process_status = ''
-		@result = ''
-		@result_api = ''
-		@result_ui = ''
-		@git_branch = ''
-		@lock = false
-	end
-
-
-	#curl localhost:8080/docker
-	#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 (to avoid concurrency) - Needs testing
-		while @lock 
-			@lock = true
-			docker_update
-			sleep 10
-
-			run_api_tests
-			run_ui_tests
-			generate_log
-			slack_post
-			@lock = false
-		end
-	end	
-
-	#update docker images locally
-	def docker_update
-		Dir.chdir(DOCKER_PATH){
-			#perform docker images update
-			`sudo docker compose kill`
-			`sudo docker compose rm`
-			`sudo docker compose up -d`
-		}
-
-	end
-	
-	#Action - run api tests
-	def run_api_tests
-		Dir.chdir(API_SPECS_PATH){
-			#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
-	
-	def run_ui_tests
-		Dir.chdir(UI_SPECS_PATH){
-			#navigate to specs dir
-			cmd = "HOST='https://#{HOST}' BROWSER=phantomjs SCREENS=true bundle exec rake selenium:#{@git_branch} | aha --black >logs/#{@git_branch}/$(date +\%d-\%m-\%Y-\%H-\%s)-UI-run.htm"
-			@result_ui = %x[#{cmd}]
-		}	
-	end
-
-	def generate_log
-		obj = {
-			"Docker logs" => @process_status,
-			"API logs" => @result_api,
-			"SE logs" => @result_ui
-		}
-		response.body = JSON.generate obj
-		response['Content-Type'] = "application/json"
-	end
-
-	def slack_post
-		#curl to post to slack for the team to see the results
-	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
-      }
+  def initialize(_param)
+    @resource_path = '/cards'
+    @repo_name = ''
+    @process_status = ''
+    @result = ''
+    @result_api = ''
+    @result_ui = ''
+    @git_branch = ''
+    @lock = false
+  end
+
+  # curl localhost:8080/docker
+  # POST call made by quay to CI server
+  def do_POST(request, _response)
+    # parse JSOn to hash key
+    request_hash = JSON.parse(request.body, symbolize_names: true)
+
+    # fetch the github repo name
+    @repo_name = request_hash[:name]
+
+    # fetch the github branch name
+    @git_branch = request_hash[:trigger_metadata][:ref]
+    @git_branch = @git_branch.split('/')
+    @git_branch = @git_branch.last
+    perform_operations
+  end
+
+  # method to perform various CI operations
+  def perform_operations
+    # handle requests one at a time (to avoid concurrency) - Needs testing
+    while @lock
+      @lock = true
+      docker_update
+      sleep 10
+
+      run_api_tests
+      run_ui_tests
+      generate_log
+      slack_post
+      @lock = false
+    end
+  end
+
+  # update docker images locally
+  def docker_update
+    Dir.chdir(DOCKER_PATH) do
+      # perform docker images update
+      `sudo docker compose kill`
+      `sudo docker compose rm`
+      `sudo docker compose up -d`
+    end
+  end
+
+  # Action - run api tests
+  def run_api_tests
+    Dir.chdir(API_SPECS_PATH) do
+      # 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 = `#{cmd}`
+      # or use ` .... ` instead of %x[ .... ] to run commands
+    end
+  end
+
+  def run_ui_tests
+    Dir.chdir(UI_SPECS_PATH) do
+      # navigate to specs dir
+      cmd = "HOST='https://#{HOST}' BROWSER=phantomjs SCREENS=true
+      	bundle exec rake selenium:#{@git_branch} |
+      	aha --black >logs/#{@git_branch}/$(date +\%d-\%m-\%Y-\%H-\%s)-UI-run.htm"
+      @result_ui = `#{cmd}`
+    end
+  end
+
+  def generate_log
+    obj = {
+      'Docker logs' => @process_status,
+      'API logs' => @result_api,
+      'SE logs' => @result_ui
     }
-  }
-}
+    response.body = JSON.generate obj
+    response['Content-Type'] = 'application/json'
+  end
 
-More info here -> http://docs.quay.io/guides/notifications.html#webhook_build_success
+  def slack_post
+    # curl to post to slack for the team to see the results
+  end
+end
 
-=end
+# Below is the POST from Quay.io, parse and use the necessary data
+#
+# {
+#   "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
+#

data/lib/continuous_integration/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ContinuousIntegration
-	VERSION = "0.0.7"
+  VERSION = '0.0.9'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: continuous_integration
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Ragavendra Nagraj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -47,9 +47,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-version"
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -62,7 +59,6 @@ files:
 - lib/continuous_integration/constants.rb
 - lib/continuous_integration/tasks.rb
 - lib/continuous_integration/version.rb
-- test/test_continuous_integration.rb
 homepage: https://rubygems.org/gems/continuous_integration
 licenses:
 - MIT
@@ -87,5 +83,4 @@ rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: One can run their UI and API tests using this gem
-test_files:
-- test/test_continuous_integration.rb
+test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-2.3.3

data/Gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'webrick'
-gem 'byebug'
-gem 'pry-byebug'

data/Gemfile.lock

@@ -1,26 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (9.0.6)
-    coderay (1.1.1)
-    method_source (0.8.2)
-    pry (0.10.4)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry-byebug (3.4.2)
-      byebug (~> 9.0)
-      pry (~> 0.10)
-    slop (3.6.0)
-    webrick (1.3.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug
-  pry-byebug
-  webrick
-
-BUNDLED WITH
-   1.13.7

data/test/test_continuous_integration.rb

@@ -1,52 +0,0 @@
-require 'minitest/autorun'
-require 'continuous_integration'
-
-class ContinuousIntegrationTest < Minitest::Test
-	def setup
-		#@server = ContinuousIntegration.setup_server
-		@root = File.expand_path "#{API_SPECS_PATH}/logs" 
-	end
-
-	def teardown
-		@server = nil
-	end
-
-	def test_order
-		:alpha
-	end
-	
-	def test_setup_server
-		#@server = ContinuousIntegration.setup_server
-#		assert_kind_of WEBrick::HTTPServer, @server, "Shutdown server did not return object"
-#		@server = ContinuousIntegration.shutdown_server @server
-		#assert_equal "hello world", Hola.hi("english")
-		#@server = ContinuousIntegration.dir_unmount @root
-	end
-	
-	def test_shutdown_server
-		@server = ContinuousIntegration.setup_server
-		t1 = Thread.new { @server = ContinuousIntegration.start_server @server }
-		assert_kind_of WEBrick::HTTPServer, @server, "Shutdown server did not return object"
-		@server = ContinuousIntegration.shutdown_server @server
-		assert_nil @server, "Server class is not nil"
-		assert t1.status, "Thread is still running"
-	end
-=begin	
-	def test_start_server
-		#@server = ContinuousIntegration.start_server @server
-		assert_empty !@server, "Start server did not return object"
-		ContinuousIntegration.shutdown_server @server
-	end
-
-	def test_create_server
-		@server = ContinuousIntegration.create_server @root
-		assert_empty !@server, "Create server did not return object"
-	end
-	
-	def test_dir_mount
-		@server = ContinuousIntegration.create_server @root
-		@server = ContinuousIntegration.dir_mount @server
-		assert_empty !@server, "Create server did not return object"
-	end	
-=end
-end