Merge pull request #4 from richdynamix/feature/ga-custom-dimensions

Feature/ga custom dimensions

Author: Steven Richardson

README.md

@@ -13,6 +13,10 @@
 - Auto configure start URL to reuse tests across multiple stages
 - Send deployment information to Google Analytics
 - Send errors to Google Analytics on failed tests
+- Send successful test runs to Google Analytics
+- Use Custom Dimensions in Google Analytics
+- Send test names as Custom Dimension
+- Track Jira tickets as Custom Dimension
 
 ## Installation
 
@@ -44,14 +48,17 @@ First thing you need to do is create your `YAML` file (`gi_config.yaml`) in the
 APIKEY: XXXXXXXXXXXXXXXXXXX
 gi_enabled: true
 rollback: true
-ga_property: ""
 suites:
     aboutpage: "XXXXXXXXXXXXXXXXXXX"
     suite2: ""
 tests:
     homepage: "XXXXXXXXXXXXXXXXXXX"
     test2: ""
     test3: ""
+ga_property: "UA-XXXXXXXX-X"
+ga_custom_1: 1
+ga_custom_2: 2
+jira_project_code: "GHOST"
 ```
 
 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. 
@@ -70,7 +77,14 @@ By default the `rollback` feature is enabled, you can disabled this for all stag
 set :rollback, false
 ```
 
-The Google Analytics property must be inserted into the `ga_property` in order to log deployments and errors. Simply update your YAML to include this `ga_property: "UA-XXXXXXXX-1"`. To disable the Google Analytics tracking just leave the `ga_property` as empty string i.e. `ga_property: ""` in your YAML
+The Google Analytics property must be inserted into the `ga_property` in order to log deployments and errors. Simply update your YAML to include this `ga_property: "UA-XXXXXXXX-1"`. To disable the Google Analytics tracking just leave the `ga_property` as empty string i.e. `ga_property: ""` in your YAML.
+
+Since version `0.3.0`, Google Analytics now uses Custom Dimensions as outlined in the [Google Measurement Protocol](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters?hl=en#cd_ "Google Measurement Protocol") documentation. When you define a new custom dimension in Google Analytics you are given a new dimension index. Default accounts have 20 available indexes where as premium accounts have 200. The `ga_custom_1` property is used to define the custom dimension for the testname and `ga_custom_2` is used to define the Jira tickets*. If you do not set the `ga_custom_1` or `ga_custom_2` properties then the default index of `1` & `2` will be used.
+
+\*_Jira tickets are extracted from the git log during the deployment. For this reason it can only track the tickets where you have correctly assigned the ticket number and identifier to the commit message. i.e._
+```
+git commit -am "GHOST-123 Add new item to the gem"
+```
 
 ## Usage
 

lib/capistrano/ghostinspector.rb

@@ -1,66 +1,173 @@
+require "capistrano"
 require "capistrano/ghostinspector/version"
 require "capistrano/ghostinspector/arrays"
 require "capistrano/ghostinspector/api"
-require "capistrano"
+require "capistrano/ghostinspector/analytics"
 
 module Capistrano
   module Ghostinspector
     def self.load_into(config)
       config.load do
-        after "deploy", "capistrano:ghostinspector:run"
+        after "deploy", "ghostinspector:setup"
+        after "ghostinspector:setup", "ghostinspector:run"
 
-        namespace :capistrano do
-          namespace :ghostinspector do
-            task :run, :only => { :primary => true } do
+        gi_config = YAML::load(File.read("gi_config.yaml"))
 
-              set :giconfig, YAML::load(File.read("gi_config.yaml"))
+        namespace :ghostinspector do
+          desc "Setup Ghost Inspector Config"
+          task :setup, :only => { :primary => true } do
 
-              # Ghost Inspector API key
-              set :gi_api_key, giconfig["APIKEY"]
+            # Ghost Inspector API key
+            set :gi_api_key, gi_config["APIKEY"]
 
-              # Google Analytics Tracking Property
-              set :ga_property, giconfig["ga_property"]
+            # Google Analytics Tracking Property
+            set :ga_property, gi_config['ga_property']
 
-              # Get tests and suites from command line
-              set :gitest, fetch(:gitest, nil)
-              set :gisuite, fetch(:gisuite, nil)
+            if gi_config.has_key?("ga_custom_1")
+              set :ga_custom_1, gi_config["ga_custom_1"]
+            else
+              set :ga_custom_1, "1"
+            end
 
-              # Check if GI is enabled for this deployment (Default: true)
-              set :gi_enabled, fetch(:gi_enabled, giconfig["gi_enabled"])
+            if gi_config.has_key?("ga_custom_2")
+              set :ga_custom_2, gi_config["ga_custom_2"]
+            else
+              set :ga_custom_2, "2"
+            end
 
-              # Should we rollback on failed GI tests (Default: true)
-              set :rollback, fetch(:rollback, giconfig["rollback"])
+            if gi_config.has_key?("jira_project_code")
+              set :jira_project_code, gi_config["jira_project_code"]
+            else
+              set :jira_project_code, "GHOST"
+            end
 
-              if (gi_enabled == true)
+            # Get tests and suites from command line
+            set :gitest, fetch(:gitest, nil)
+            set :gisuite, fetch(:gisuite, nil)
 
-                # run each test
-                Capistrano::Ghostinspector.getTests(gitest, giconfig["tests"]).each do |test|
-                  puts "* * * Running Ghost Inspector Test * * *"
-                  set :passing, Capistrano::Ghostinspector::Api.executeApi("tests", test, gi_api_key, domain, rollback, ga_property, current_revision[0,7])
-                end
+            # Check if GI is enabled for this deployment (Default: true)
+            set :gi_enabled, fetch(:gi_enabled, gi_config['gi_enabled'])
 
-                # run each suite
-                Capistrano::Ghostinspector.getTests(gisuite, giconfig["suites"]).each do |suite|
-                  puts "* * * Running Ghost Inspector Suite * * *"
-                  set :passing, Capistrano::Ghostinspector::Api.executeApi("suites", suite, gi_api_key, domain, rollback, ga_property, current_revision[0,7])
-                end
+            # Should we rollback on failed GI tests (Default: true)
+            set :rollback, fetch(:rollback, gi_config['rollback'])
+          end
+          
+          desc "Run Ghost Inspector Tests"
+          task :run, :only => { :primary => true } do
+
+            if (fetch(:gi_enabled) == true)
+
+              giApi = Api.new(fetch(:gi_api_key), fetch(:domain), fetch(:rollback), fetch(:ga_property))
+              
+              @collection = Array.new
+              # run each test
+              Capistrano::Ghostinspector.getTests(fetch(:gitest), gi_config["tests"]).each do |test|
+                puts "* * * Running Ghost Inspector Test * * *"
+                set :data, giApi.executeApi("tests", test)
+
+                items = { :passing => data[0], :results => data[1], :type =>  "tests"}
+                @collection << items
+              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 * * *"
+              # run each suite
+              Capistrano::Ghostinspector.getTests(fetch(:gisuite), gi_config["suites"]).each do |suite|
+                puts "* * * Running Ghost Inspector Suite * * *"
+                set :data, giApi.executeApi("suites", suite)
+
+                data[1]["data"].each do |test|
+                  items = { :passing => test["passing"], :results => test, :type =>  "suites"}
+                  @collection << items
                 end
 
               end
+
+            end
+
+          end
+
+          desc "Send Results to Google Analytics"
+          task :sendGA, :only => { :primary => true } do
+
+            puts "* * * Sending Data to Google Analytics * * *"
+
+            jira_project_code = fetch(:jira_project_code)
+
+            log = capture(
+              "cd #{current_path} && git log #{previous_revision[0,7]}..#{current_revision[0,7]} --format=\"%s\" | grep -oh '#{jira_project_code}-[0-9]\\+' | sort | uniq"
+            )
+
+            options = { 
+              :ga_property => fetch(:ga_property),
+              :ga_custom_1 => fetch(:ga_custom_1),
+              :ga_custom_2 => fetch(:ga_custom_2),
+              :domain => fetch(:domain), 
+              :current_revision => fetch(:current_revision),
+              :previous_revision => fetch(:previous_revision),
+              :branch => fetch(:branch, "default"),
+              :stage => fetch(:stage),
+              :tickets => Capistrano::Ghostinspector.getTickets(log)
+            }
+
+            analytics = Analytics.new(options)
+
+            @collection.each do |item|
+              analytics.pushData(item[:type], item[:results])
+            end
+
+          end
+
+          desc "Finalise Ghost Inspector Run"
+          task :finalise_run, :only => { :primary => true } do
+
+            set :passing, true
+            @collection.each do |item|
+              if item[:passing] == false
+                set :passing, false
+              end
             end
+
+            # If any test fails and the stage allows rollbacks then
+            # rollback to previous version.
+            if (fetch(:passing) == false && fetch(:rollback) == true)
+              puts "* * * Ghost Inspector Failed. Rolling back * * *"
+              run_locally %{cap #{stage} deploy:rollback}
+            else
+              puts "* * * Ghost Inspector Complete. Deployment Complete * * *"
+            end
+
           end
+
         end
 
+
+        after "ghostinspector:run", "ghostinspector:sendGA"
+        after "ghostinspector:sendGA", "ghostinspector:finalise_run"
+
       end
     end
+
+
+    def self.getTickets(log)
+
+        tickets = ""
+        log.each_line do |line|
+            line.delete!('";')
+            line.strip!
+            line.gsub!("'", '\u0027')
+            tickets = "#{tickets}, #{line}"
+        end
+
+        if (tickets.to_s == "")
+            tickets = "None"
+        else
+            tickets[0] = ''
+        end
+
+        return tickets
+
+    end
+
+
   end
 end
 

lib/capistrano/ghostinspector/analytics.rb

@@ -1,33 +1,95 @@
-require "capistrano/ghostinspector/analytics"
 require "staccato"
 
 module Capistrano
   module Ghostinspector
-	  module Analytics
-	    def self.pushDeployment(ga_property, current_revision)
+    class Analytics
+      def initialize(options)
+        @options = options
+        @tracker = Staccato.tracker(options[:ga_property])
+      end
 
-	    	tracker = Staccato.tracker(ga_property)
+      def pushData(type, results)
 
-			# inform GA of a new deployment
-			tracker.event(category: 'deployment', action: 'deploy', label: current_revision, non_interactive: true)
+        # Lets push the deployment in GA if the configuration allows it.
+        pushDeployment()
 
-	    end
+        if type == "tests"
+          testname = "GI TEST - " + results["data"]["test"]["name"]
 
-	    def self.pushErrors(ga_property, current_revision, data)
+          if results["data"]["passing"] == true
+            trackData(results["data"]["steps"], testname, "success")
+          else
+            trackData(results["data"]["steps"], testname, "error")
+          end
 
-			tracker = Staccato.tracker(ga_property)
+        else
 
-			data['steps'].each do |step|
+          testname = "GI TEST - " + results["testName"]
 
-				if (step['passing'] == false)
-					# send the errors to GA
-					tracker.event(category: 'error', action: step['error'], label: "Command: #{step['command']} - Target: #{step['target']}", non_interactive: true)
-				end
+          if results["passing"] == true
+            trackData(results["steps"], testname, "success")
+          else
+            trackData(results["steps"], testname, "error")
+          end
 
-			end
+        end
 
-	    end
+      end
 
-	  end
+      private
+
+      def pushDeployment()
+
+        # inform GA of a new deployment
+        @action = "deploy to #{@options[:stage]}"
+        current_revision = @options[:current_revision][0,7]
+        previous_revision = @options[:previous_revision][0,7]
+        @deployed = "Deployed revision #{current_revision} from branch #{@options[:branch]} (replacing #{previous_revision})"
+        hit = Staccato::Event.new(@tracker, category: 'deployment', action: @action, label: @deployed, document_hostname: @options[:domain], document_path: @action)
+        hit.add_custom_dimension(@options[:ga_custom_1], "deployment")
+        hit.add_custom_dimension(@options[:ga_custom_2], "#{@options[:tickets]}")
+        hit.track!
+
+      end
+
+      def trackData(steps, testName, type)
+
+        if type == 'success'
+          steps.each do |step|
+
+            hit = Staccato::Event.new(@tracker, category: 'success', action: step['command'], label: step['target'], document_hostname: @options[:domain], document_path: testName)
+            hit.add_custom_dimension(@options[:ga_custom_1], testName)
+            hit.add_custom_dimension(@options[:ga_custom_2], "#{@options[:tickets]}")
+            hit.track!
+
+          end
+          # pageView(testName)
+        else
+          steps.each do |step|
+
+            if (step['passing'] == false)
+              # send the errors to GA
+
+              hit = Staccato::Event.new(@tracker, category: 'error', action: step['error'], label: "Command: #{step['command']} - Target: #{step['target']}", document_hostname: @options[:domain], document_path: testName)
+              hit.add_custom_dimension(@options[:ga_custom_1], testName)
+              hit.add_custom_dimension(@options[:ga_custom_2], "#{@options[:tickets]}")
+              hit.track!
+            end
+
+          end
+        end
+
+      end
+
+      def pageView(testName)
+
+        hit = Staccato::Pageview.new(@tracker, hostname: @options[:domain], path: testName, title: testName, document_hostname: @options[:domain])
+        hit.add_custom_dimension(@options[:ga_custom_1], testName)
+        hit.add_custom_dimension(@options[:ga_custom_2], "#{@options[:tickets]}")
+        hit.track!
+
+      end
+
+    end
   end
-end
+end