govuk_ab_testing 1.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60c87598019b68f5a95ea973ebec062cf6972f81
-  data.tar.gz: 6d18e3e60365d2cc471abed1065127a2f277ccf2
+  metadata.gz: 855c19cb71753681212ec44568952404cda4be1f
+  data.tar.gz: 003b91391e240a88f29321d2f37674895017df3a
 SHA512:
-  metadata.gz: 763e5aeca3ce16310d2b4923c80722310ee3669c2dccc5d54070075d4d57b06f361f4c324e925e5ac975b166662f0c86e2a25726761e923b5322867f23205545
-  data.tar.gz: 3afb6e0ea32979ff411421723b27438dcfce0d55a571fdb6e116b9c8c836ab98e987efca2d21e5c67486a3cf72c22caf417095f30cc6c7fbd6ba85f1502701f6
+  metadata.gz: efbeee80a3643a4d3839842841b552cef0e2fe61addfc818cd5649626d2be38f4579369f33359d02ce46f52ad24c2c18447bbb3d756a8848f8951c28bc310926
+  data.tar.gz: 5553b89840a15687c569c3d59c0ccb1877e36664974558e67a0572b7bde005be35459cc9feff64b15eb4cb4922ca75280525b218ddd5e7b1764fe7a997d2d21d

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 2.0.0
+
+* **BREAKING CHANGE** `assert_response_not_modified_for_ab_test` now
+  requires a parameter to indicate what A/B test we are referring to.
+  This allows for multiple A/B tests to exist without letting the test
+  cases fail in case they encounter a different A/B test in the Vary header;
+* **BREAKING CHANGE** `assert_page_not_tracked_in_ab_test` now also
+  requires a parameter to indicate what A/B test we are referring to.
+  The reason is similar to the one mentioned above;
+* New class introduced to represent a meta tag. This lets us query if a
+  given meta tag belongs to a given A/B test.
+
 ## 1.0.4
 
 * Port the individual set-up and assertion steps from Minitest to RSpec

data/Jenkinsfile

@@ -1,45 +1,6 @@
 #!/usr/bin/env groovy
 
-REPOSITORY = 'govuk_ab_testing'
-
 node {
   def govuk = load '/var/lib/jenkins/groovy_scripts/govuk_jenkinslib.groovy'
-
-  try {
-    stage('Checkout') {
-      checkout scm
-    }
-
-    stage('Clean') {
-      govuk.cleanupGit()
-      govuk.mergeMasterBranch()
-    }
-
-    stage('Bundle') {
-      echo 'Bundling'
-      sh("bundle install --path ${JENKINS_HOME}/bundles/${JOB_NAME}")
-    }
-
-    stage('Linter') {
-      govuk.rubyLinter()
-    }
-
-    stage('Tests') {
-      govuk.runTests()
-    }
-
-    if(env.BRANCH_NAME == "master") {
-      stage('Publish Gem') {
-        govuk.publishGem(REPOSITORY, env.BRANCH_NAME)
-      }
-    }
-
-  } catch (e) {
-    currentBuild.result = 'FAILED'
-    step([$class: 'Mailer',
-          notifyEveryUnstableBuild: true,
-          recipients: 'govuk-ci-notifications@digital.cabinet-office.gov.uk',
-          sendToIndividuals: true])
-    throw e
-  }
+  govuk.buildProject()
 }

data/README.md

@@ -132,7 +132,7 @@ class PartyControllerTest < ActionController::TestCase
 
     get :show
 
-    assert_response_not_modified_for_ab_test
+    assert_response_not_modified_for_ab_test("your_ab_test_name")
   end
 end
 ```
@@ -152,7 +152,7 @@ class PartyControllerTest < ActionController::TestCase
     get :show
 
     assert_response_is_cached_by_variant("your_ab_test_name")
-    assert_page_not_tracked_in_ab_test
+    assert_page_not_tracked_in_ab_test("your_ab_test_name")
   end
 end
 ```

data/lib/govuk_ab_testing/acceptance_tests/active_support.rb

@@ -21,20 +21,19 @@ module GovukAbTesting
         response.headers['Vary']
       end
 
-      def analytics_meta_tags
-        scope.css_select(ANALYTICS_META_TAG_SELECTOR)
-      end
-
-      def analytics_meta_tag
-        analytics_meta_tags.first
+      def analytics_meta_tags_for_test(ab_test_name)
+        analytics_meta_tags.select { |tag| tag.for_ab_test?(ab_test_name) }
       end
 
-      def content
-        analytics_meta_tag.attributes['content'].value
-      end
+      def analytics_meta_tags
+        tags = scope.css_select(ANALYTICS_META_TAG_SELECTOR)
 
-      def dimension
-        analytics_meta_tag.attributes['data-analytics-dimension'].value
+        tags.map do |tag|
+          MetaTag.new(
+            content: tag.attributes['content'].value,
+            dimension: tag.attributes['data-analytics-dimension'].value
+          )
+        end
       end
     end
   end

data/lib/govuk_ab_testing/acceptance_tests/capybara.rb

@@ -25,20 +25,19 @@ module GovukAbTesting
         capybara_page.response_headers['Vary']
       end
 
-      def analytics_meta_tags
-        capybara_page.all(ANALYTICS_META_TAG_SELECTOR, visible: :all)
-      end
-
-      def analytics_meta_tag
-        analytics_meta_tags.first
+      def analytics_meta_tags_for_test(ab_test_name)
+        analytics_meta_tags.select { |tag| tag.for_ab_test?(ab_test_name) }
       end
 
-      def content
-        analytics_meta_tag['content']
-      end
+      def analytics_meta_tags
+        tags = capybara_page.all(ANALYTICS_META_TAG_SELECTOR, visible: :all)
 
-      def dimension
-        analytics_meta_tag['data-analytics-dimension']
+        tags.map do |tag|
+          MetaTag.new(
+            content: tag['content'],
+            dimension: tag['data-analytics-dimension']
+          )
+        end
       end
     end
   end

data/lib/govuk_ab_testing/acceptance_tests/meta_tag.rb

@@ -0,0 +1,16 @@
+module GovukAbTesting
+  module AcceptanceTests
+    class MetaTag
+      attr_reader :content, :dimension
+
+      def initialize(content:, dimension:)
+        @content = content
+        @dimension = dimension
+      end
+
+      def for_ab_test?(ab_test_name)
+        content.match(/#{ab_test_name}/i)
+      end
+    end
+  end
+end

data/lib/govuk_ab_testing/minitest_helpers.rb

@@ -25,24 +25,25 @@ module GovukAbTesting
         expected_content =
           ab_test.meta_tag_name + ':' + requested_variant.variant_name
         message = "You probably forgot to add the `analytics_meta_tag` to the views"
-        meta_tags = acceptance_test_framework.analytics_meta_tags
+        meta_tags =
+          acceptance_test_framework.analytics_meta_tags_for_test(ab_test_name)
 
         assert_equal(1, meta_tags.count, message)
 
-        dimension_value = acceptance_test_framework.dimension
+        meta_tag = meta_tags.first
 
         assert_equal(
           expected_content,
-          acceptance_test_framework.content,
-          "Meta tag's content doesn't match."
+          meta_tag.content,
+          "Meta tag's content doesnt match."
         )
 
         if dimension.nil?
-          assert(dimension_value, "No custom dimension number found")
+          assert(meta_tag.dimension, "No custom dimension number found")
         else
           assert_equal(
             dimension.to_s,
-            dimension_value,
+            meta_tag.dimension,
             "The custom dimension found in meta tag doesn't match"
           )
         end
@@ -63,17 +64,27 @@ module GovukAbTesting
         "You probably forgot to use `configure_response`"
     end
 
-    def assert_response_not_modified_for_ab_test
-      assert_nil acceptance_test_framework.vary_header(response),
+    def assert_response_not_modified_for_ab_test(ab_test_name)
+      vary_header = acceptance_test_framework.vary_header(response)
+
+      assert_no_match(
+        /#{ab_test_name}/,
+        vary_header,
         "`Vary` header is being added to a page which should not be modified by the A/B test"
+      )
 
-      assert_page_not_tracked_in_ab_test
+      assert_page_not_tracked_in_ab_test(ab_test_name)
     end
 
-    def assert_page_not_tracked_in_ab_test
-      meta_tags = acceptance_test_framework.analytics_meta_tags
-      assert_equal(0, meta_tags.count,
-        "A/B meta tag is being added to a page which should not be modified by the A/B test")
+    def assert_page_not_tracked_in_ab_test(ab_test_name)
+      meta_tags =
+        acceptance_test_framework.analytics_meta_tags_for_test(ab_test_name)
+
+      assert_equal(
+        0,
+        meta_tags.count,
+        "A/B meta tag is being added to a page which should not be modified by the A/B test"
+      )
     end
   end
 end

data/lib/govuk_ab_testing/rspec_helpers.rb

@@ -22,12 +22,15 @@ module GovukAbTesting
 
       unless args[:assert_meta_tag] == false
         content = [ab_test.meta_tag_name, requested_variant.variant_name].join(':')
-        ab_test_metatags = acceptance_test_framework.analytics_meta_tags
+        ab_test_metatags =
+          acceptance_test_framework.analytics_meta_tags_for_test(ab_test_name)
 
         expect(ab_test_metatags.count).to eq(1)
 
-        expect(acceptance_test_framework.content).to eq(content)
-        dimension = acceptance_test_framework.dimension
+        meta_tag = ab_test_metatags.first
+
+        expect(meta_tag.content).to eq(content)
+        dimension = meta_tag.dimension
 
         if dimension.nil?
           expect(dimension).to_not be_nil
@@ -50,15 +53,18 @@ module GovukAbTesting
       expect(vary_header_value).to eq(ab_test.response_header)
     end
 
-    def assert_response_not_modified_for_ab_test
-      expect(acceptance_test_framework.vary_header).to be_nil,
+    def assert_response_not_modified_for_ab_test(ab_test_name)
+      vary_header = acceptance_test_framework.vary_header
+
+      expect(vary_header).to_not match?(/#{ab_test_name}/),
         "`Vary` header is being added to a page which should not be modified by the A/B test"
 
-      assert_page_not_tracked_in_ab_test
+      assert_page_not_tracked_in_ab_test(ab_test_name)
     end
 
-    def assert_page_not_tracked_in_ab_test
-      meta_tags = acceptance_test_framework.analytics_meta_tags
+    def assert_page_not_tracked_in_ab_test(ab_test_name)
+      meta_tags =
+        acceptance_test_framework.analytics_meta_tags_for_test(ab_test_name)
 
       expect(meta_tags).to be_empty,
         "A/B meta tag is being added to a page which should not be modified by the A/B test"

data/lib/govuk_ab_testing/version.rb

@@ -1,3 +1,3 @@
 module GovukAbTesting
-  VERSION = "1.0.4".freeze
+  VERSION = "2.0.0".freeze
 end

data/lib/govuk_ab_testing.rb

@@ -4,6 +4,7 @@ require "govuk_ab_testing/requested_variant"
 require "govuk_ab_testing/ab_test"
 require "govuk_ab_testing/minitest_helpers"
 require "govuk_ab_testing/rspec_helpers"
+require 'govuk_ab_testing/acceptance_tests/meta_tag'
 require 'govuk_ab_testing/acceptance_tests/capybara'
 require 'govuk_ab_testing/acceptance_tests/active_support'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_ab_testing
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 2.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-07 00:00:00.000000000 Z
+date: 2017-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -104,6 +104,7 @@ files:
 - lib/govuk_ab_testing/ab_test.rb
 - lib/govuk_ab_testing/acceptance_tests/active_support.rb
 - lib/govuk_ab_testing/acceptance_tests/capybara.rb
+- lib/govuk_ab_testing/acceptance_tests/meta_tag.rb
 - lib/govuk_ab_testing/configuration.rb
 - lib/govuk_ab_testing/minitest_helpers.rb
 - lib/govuk_ab_testing/requested_variant.rb