capistrano-ghostinspector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc04965ad83dd32a46922bb4945d37f6523c591b
+  data.tar.gz: ee6edf4ae49d651e917393b5c0e9570cd612c48b
+SHA512:
+  metadata.gz: 1c56e3ac17840978f33e429ec681291e1287ac34b6a7a08cc2daaa3f91b2fe6a2abcf20e1b71a41600937c4bdf246d1f615f363168377683bcf19f956c2fd5d4
+  data.tar.gz: d90f5869f9c89757f6f69d2a5e9286484210b7f0230d2829bf0db76c29732589dd11521b62d0a5548d82bec370f2753fa5382a7ebdffa27d2bb4990159a73b49

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-ghostinspector.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Steven Richardson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+# Capistrano::Ghostinspector
+
+[![Scrutinizer Code Quality](https://www2.scrutinizer-ci.com/g/richdynamix/capistrano-ghostinspector/badges/quality-score.png?b=develop)](https://www2.scrutinizer-ci.com/g/richdynamix/capistrano-ghostinspector/?branch=develop) [![Build Status](https://www2.scrutinizer-ci.com/g/richdynamix/capistrano-ghostinspector/badges/build.png?b=develop)](https://www2.scrutinizer-ci.com/g/richdynamix/capistrano-ghostinspector/build-status/develop)
+
+
+[Ghost Inspector](https://ghostinspector.com/ "Ghost Inspector") is an automated website regression testing tool. This [Capistrano](http://capistranorb.com/ "Capistrano") plugin is a simple, configurable gem that will provide the following features.
+
+
+#### Features
+- Set individual tests/suites to run from command line
+- Exclude individual stages
+- Auto rollback to previous version on failed tests (can be disabled in config per stage)
+- Auto configure start URL to reuse tests across multiple stages
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-ghostinspector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-ghostinspector
+
+And the add the following to the top of your `deploy.rb` file
+
+```ruby
+require 'capistrano/ghostinspector'
+```
+
+## Configuration
+
+First thing you need to do is create your `YAML` file (`gi_config.yaml`) in the Capistrano folder with the following format -
+```
+---
+APIKEY: XXXXXXXXXXXXXXXXXXX
+gi_enabled: true
+rollback: true
+suites:
+    aboutpage: "XXXXXXXXXXXXXXXXXXX"
+    suite2: ""
+tests:
+    homepage: "XXXXXXXXXXXXXXXXXXX"
+    test2: ""
+    test3: ""
+```
+
+You can obtain your API key, suite ID and test ID from your Ghost Inspector console. At the bottom right of the suite page you will see API Access e.g. 
+`https://api.ghostinspector.com/v1/suites/`SUITE ID IS HERE`/execute/?apiKey=`API KEY ID IS HERE
+
+Add as many suites or tests as you like, the name you give your test isn't important but you should make it easy to remember when executing the test.
+
+By default the ghost inspector execution is enabled, you can disabled this for all stages by setting `gi_enabled: false` in the `YAML` file. Alternatively you can change this on a per stage basis by setting the appropriate variable 
+```ruby
+set :gi_enabled, false
+``` 
+This ensures that Ghost Inspector is not automatically run when accidentally triggered via the command line.
+
+By default the `rollback` feature is enabled, you can disabled this for all stages by setting `rollback: false` in the `YAML` file. Alternatively you can change this on a per stage basis by setting the appropriate variable 
+```ruby
+set :rollback, false
+```
+
+## Usage
+
+Run a particular test when deploying to staging -
+
+	$ cap staging deploy -s gitest=homepage
+
+
+Run a multiple tests when deploying to staging -
+
+	$ cap staging deploy -s gitest=homepage,test2,test3
+
+
+Run a particular suite when deploying to staging -
+
+	$ cap staging deploy -s gisuite=aboutpage
+
+
+Run a multiple suites when deploying to staging -
+
+	$ cap staging deploy -s gisuite=aboutpage,suite2
+
+
+## Contributing
+
+1. Fork it ( https://github.com/richdynamix/capistrano-ghostinspector/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/capistrano-ghostinspector.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/ghostinspector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-ghostinspector"
+  spec.version       = Capistrano::Ghostinspector::VERSION
+  spec.authors       = ["Steven Richardson"]
+  spec.email         = ["steven@richdynamix.com"]
+  spec.summary       = "Ghost Inspector - Capistrano"
+  spec.description   = "A Ghost Inspector plugin for Capistrano"
+  spec.homepage      = 'http://rubygems.org/gems/capistrano-ghostinspector'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'capistrano', "~> 2.15.5"
+  spec.add_development_dependency 'capistrano-spec'
+end

data/lib/capistrano/ghostinspector.rb

@@ -0,0 +1,66 @@
+require "capistrano/ghostinspector/version"
+require "capistrano/ghostinspector/arrays"
+require "capistrano/ghostinspector/api"
+require "capistrano"
+
+module Capistrano
+  module Ghostinspector
+    def self.load_into(config)
+      config.load do
+        after "deploy", "capistrano:ghostinspector:run"
+
+        namespace :capistrano do
+          namespace :ghostinspector do
+            task :run, :only => { :primary => true } do
+
+              set :giconfig = YAML::load(File.read("gi_config.yaml"))
+
+              set :gi_api_key, giconfig["APIKEY"]
+
+              # Get tests and suites from command line
+              set :gitest, fetch(:gitest, nil)
+              set :gisuite, fetch(:gisuite, nil)
+
+              # Check if GI is enabled for this deployment (Default: true)
+              set :gi_enabled, fetch(:gi_enabled, giconfig["gi_enabled"])
+
+              # Should we rollback on failed GI tests (Default: true)
+              set :rollback, fetch(:rollback, giconfig["rollback"])
+
+              if (gi_enabled == true)
+
+                # run each test
+                Capistrano::Ghostinspector.getTests(gitest, giconfig["tests"]).each do |test|
+                  puts "* * * Running Ghost Inspector Test * * *"
+                  set :passing, Capistrano::Ghostinspector.executeApi("tests", test, gi_api_key, domain, rollback)
+                end
+
+                # run each suite
+                Capistrano::Ghostinspector.getTests(gisuite, giconfig["suites"]).each do |suite|
+                  puts "* * * Running Ghost Inspector Suite * * *"
+                  set :passing, Capistrano::Ghostinspector.executeApi("suites", suite, gi_api_key, domain, rollback)
+                end
+
+                # If any test fails and the stage allows rollbacks then
+                # rollback to previous version.
+                if (passing == false && rollback == true)
+                  puts "* * * Ghost Inspector Failed. Rolling back * * *"
+                  run_locally %{cap #{stage} deploy:rollback}
+                else
+                  puts "* * * Ghost Inspector Complete. Deployment Complete * * *"
+                end
+
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end
+
+
+if Capistrano::Configuration.instance
+  Capistrano::Ghostinspector.load_into(Capistrano::Configuration.instance)
+end

data/lib/capistrano/ghostinspector/api.rb

@@ -0,0 +1,42 @@
+require 'net/https'
+require 'json'
+
+module Capistrano
+  module Ghostinspector
+    def self.executeApi(type, test, gi_api_key, domain, rollback)
+
+    	# Determine if we should get results to 
+    	# check for any failed tests
+		if (rollback == false)
+			immediate = "&immediate=1"
+		else
+			immediate = ""
+			puts "* * * Gathering results. This could take a few minutes. * * *"
+		end
+		
+		# Default all tests pass
+		passing = true
+
+		# execute the Ghost Inspector API call
+		uri = URI("https://api.ghostinspector.com/v1/#{type}/#{test}/execute/?apiKey=#{gi_api_key}&startUrl=http://#{domain}/#{immediate}")
+		data = Net::HTTP.get(uri)
+
+		# Check the data returned for failed tests
+		if (rollback == true) 
+			results = JSON.parse(data)
+
+			if (type == "suite")
+				results['data'].each do |testItem|                  
+				  passing = testItem['passing']
+				end
+			else 
+				passing = results['data']['passing']
+			end
+
+		end
+
+		return passing
+		
+    end
+  end
+end

data/lib/capistrano/ghostinspector/arrays.rb

@@ -0,0 +1,20 @@
+module Capistrano
+  module Ghostinspector
+    def self.getTests(test, giconfig)
+
+		# Return an array of tests/suites to
+		# run in ghost inspector
+		array = Array.new
+		if (test != nil)
+		  test.split(',').each do |key|
+		    if (giconfig.has_key?(key))
+		      array << giconfig[key] 
+		    end 
+		  end
+		end
+
+		return array
+
+    end
+  end
+end

data/lib/capistrano/ghostinspector/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Ghostinspector
+    VERSION = "0.1.0"
+  end
+end

data/spec/capistrano-ghostinspector_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe "Ghostinspector" do
+  before do
+    @configuration = Capistrano::Configuration.new
+    @configuration.extend(Capistrano::Spec::ConfigurationExtension)
+
+    Capistrano::Ghostinspector.load_into(@configuration)
+  end
+
+  subject { @configuration }
+
+	context "when running capistrano:ghostinspector:run" do
+		before do
+			@configuration.set :gitest, 'home'
+		end
+
+	    it "it should define tests" do
+			@configuration.fetch(:gitest).should == 'home'
+		end
+
+	end
+
+end
+
+
+
+
+
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'capistrano'
+
+require 'capistrano-spec'
+require 'rspec'
+
+# Add capistrano-spec matchers and helpers to RSpec
+RSpec.configure do |config|
+  config.include Capistrano::Spec::Matchers
+  config.include Capistrano::Spec::Helpers
+end

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-ghostinspector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steven Richardson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.5
+- !ruby/object:Gem::Dependency
+  name: capistrano-spec
+  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: A Ghost Inspector plugin for Capistrano
+email:
+- steven@richdynamix.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-ghostinspector.gemspec
+- lib/capistrano/ghostinspector.rb
+- lib/capistrano/ghostinspector/api.rb
+- lib/capistrano/ghostinspector/arrays.rb
+- lib/capistrano/ghostinspector/version.rb
+- spec/capistrano-ghostinspector_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: http://rubygems.org/gems/capistrano-ghostinspector
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ghost Inspector - Capistrano
+test_files:
+- spec/capistrano-ghostinspector_spec.rb
+- spec/spec_helper.rb