deprecation_toolkit 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddd5dffb6bef31488bd68ff821e1f5972393faf9a662822846b6329ed6224d22
-  data.tar.gz: 01d152d7fac7479039f518c38f1bbd7dae49aaa090c62a0cd42d99b99c800484
+  metadata.gz: c2aa284de572854194d47e8fb3a0928f6004e657c957fc3818a646f7f87baa2e
+  data.tar.gz: 80c06869204811d135e0ca7933aad4d29d58c297d78c586aef170f35400fe809
 SHA512:
-  metadata.gz: 7834446b68db25c28bc19f17cefead446cd390846af1cdde3bb8183a5eda53c87ea95fc1abcdf71b080486d80b0c9c5497986061146f81752742e2c4fc5e6e8f
-  data.tar.gz: 6307da3564c55fa2879fd99b610bd923eaf5247abd33bb39ec96c974f9c4cf7f8f5fa2e8392b493735950ff7f0afde18110036844b326971ea2f8ed674cb7dc1
+  metadata.gz: f6919678301384aee34d895fc914b044af7729261ebeb0c1cf50b50eb3bc2c8cb696225fc24a6a74eccc525394b89d0b3f2e6f250862f58d4c8cc775e88a635f
+  data.tar.gz: ce5328b98b756eb6c19f163e58333cfd1a3f3ed286d34cf5bb9dbdabf97a00f0678b7663e8c7825811ee28b0f51f27eed78da7cf66496d41cda257d93101f23c

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master (unreleased)
 
+## 1.3.0 (2019-02-28)
+* [#38](https://github.com/Shopify/deprecation_toolkit/pull/38): Add a way to mark test as flaky. (@Edouard-chin)
+* [#39](https://github.com/Shopify/deprecation_toolkit/pull/39): Introduced a way to help recording massive amount of deprecations. (@Edouard-chin)
+
 ## 1.2.1 (2019-01-09)
 
 ### Bug fixes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    deprecation_toolkit (1.2.2)
+    deprecation_toolkit (1.3.0)
       activesupport (>= 4.2)
 
 GEM

data/README.md

@@ -52,6 +52,7 @@ This gem provides 3 behaviors, the default one being `DeprecationToolkit::Behavi
   - `DeprecationToolkit::DeprecationIntroduced` error if a new deprecation is introduced.
   - `DeprecationToolkit::DeprecationRemoved` error if a deprecation was removed (compare to the one recorded in the shitlist).
 * `DeprecationToolkit::Behaviors::Record` will record deprecations.
+* `DeprecationToolkit::Behaviors::CIRecordHelper` See separated explanation below.
 * `DeprecationToolkit::Behaviors::Disabled` will do nothing.
   - This is useful if you want to disable this gem for a moment without removing the gem from your Gemfile.
 
@@ -71,6 +72,15 @@ end
 DeprecationToolkit::Configuration.behavior = StatsdBehavior
 ```
 
+##### DeprecationToolkit::Behaviors::CIRecordHelper
+
+This is a special type of behaviour meant to help you record deprecations if you have a lof of them.
+Imagine if you have thousands of tests and need to record deprecations for each on your machine, this is going to take ages.
+Recording deprecations on CI with the regular `Record` behavior isn't possible because of the way CI parallelize test in multiple container (Multiple tests from the same file runs in parallel in diferrent machines, the deprecation files that get created are then splitted. Regrouping them is a nightmare.)
+
+This behaviour will output a JSON representation of your deprecations. Your CI should have a way to download the log generated from the test run. Download it on your locale machine. Finally run the rake task `FILEPATH=<path_to_downloaded_log> deprecation_toolkit:record_from_ci_output`.
+This task will parse your CI log and grab the output generated by the DeprecationToolkit and will finally convert everything back to YML files.
+
 ### 🔨 `#DeprecationToolkit::Configuration#allowed_deprecations`
 
 You can ignore some deprecations using `allowed_deprecations`. `allowed_deprecations` accepts an array of Regexp and Procs.

data/lib/deprecation_toolkit.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+load('tasks/ci_recorder.rake')
+
 module DeprecationToolkit
   autoload :DeprecationSubscriber,     "deprecation_toolkit/deprecation_subscriber"
   autoload :Configuration,             "deprecation_toolkit/configuration"
@@ -10,6 +12,7 @@ module DeprecationToolkit
     autoload :Disabled,                "deprecation_toolkit/behaviors/disabled"
     autoload :Raise,                   "deprecation_toolkit/behaviors/raise"
     autoload :Record,                  "deprecation_toolkit/behaviors/record"
+    autoload :CIRecordHelper,          "deprecation_toolkit/behaviors/ci_record_helper"
   end
 
   def self.add_notify_behavior

data/lib/deprecation_toolkit/behaviors/ci_record_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module DeprecationToolkit
+  module Behaviors
+    class CIRecordHelper
+      extend ReadWriteHelper
+
+      HEADER = '[DeprecationToolkit]'
+
+      def self.trigger(test, current_deprecations, _recorded_deprecations)
+        filename = recorded_deprecations_path(test)
+
+        to_output = {
+          filename.to_s => {
+            test.name => current_deprecations.deprecations_without_stacktrace,
+          },
+        }
+
+        raise "#{HEADER} #{JSON.dump(to_output)}"
+      end
+    end
+  end
+end

data/lib/deprecation_toolkit/behaviors/record.rb

@@ -6,7 +6,9 @@ module DeprecationToolkit
       extend ReadWriteHelper
 
       def self.trigger(test, collector, _)
-        write(test, collector.deprecations_without_stacktrace)
+        deprecation_file = recorded_deprecations_path(test)
+
+        write(deprecation_file, test.name => collector.deprecations_without_stacktrace)
       end
     end
   end

data/lib/deprecation_toolkit/collector.rb

@@ -59,5 +59,9 @@ module DeprecationToolkit
 
       difference
     end
+
+    def flaky?
+      size == 1 && deprecations.first['flaky'] == true
+    end
   end
 end

data/lib/deprecation_toolkit/minitest_hook.rb

@@ -7,7 +7,7 @@ module DeprecationToolkit
     def trigger_deprecation_toolkit_behavior
       current_deprecations = Collector.new(Collector.deprecations)
       recorded_deprecations = Collector.load(self)
-      if current_deprecations != recorded_deprecations
+      if !recorded_deprecations.flaky? && current_deprecations != recorded_deprecations
         Configuration.behavior.trigger(self, current_deprecations, recorded_deprecations)
       end
     ensure

data/lib/deprecation_toolkit/read_write_helper.rb

@@ -7,21 +7,22 @@ require "yaml"
 module DeprecationToolkit
   module ReadWriteHelper
     def read(test)
-      deprecation_file = recorded_deprecations_path(test)
+      deprecation_file = Bundler.root.join(recorded_deprecations_path(test))
       YAML.load(deprecation_file.read).fetch(test.name, [])
     rescue Errno::ENOENT
       []
     end
 
-    def write(test, deprecations)
-      deprecation_file = recorded_deprecations_path(test)
+    def write(deprecation_file, deprecations_to_record)
       create_deprecation_file(deprecation_file) unless deprecation_file.exist?
 
       content = YAML.load_file(deprecation_file)
-      if deprecations.any?
-        content[test.name] = deprecations
-      else
-        content.delete(test.name)
+      deprecations_to_record.each do |test_name, deprecations|
+        if deprecations.any?
+          content[test_name] = deprecations
+        else
+          content.delete(test_name)
+        end
       end
 
       if content.any?
@@ -45,7 +46,7 @@ module DeprecationToolkit
         Configuration.deprecation_path
       end
 
-      Bundler.root.join(deprecation_folder, "#{test.class.name.underscore}.yml")
+      Pathname(deprecation_folder).join("#{test.class.name.underscore}.yml")
     end
 
     def test_location(test)

data/lib/deprecation_toolkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeprecationToolkit
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/lib/tasks/ci_recorder.rake

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'json'
+require 'active_support/core_ext/hash'
+require 'rake'
+require_relative '../deprecation_toolkit/read_write_helper'
+
+class CIRecorder
+  include Rake::DSL
+  include DeprecationToolkit::ReadWriteHelper
+
+  def initialize
+    namespace :deprecation_toolkit do
+      desc 'Parse a file generated with the CIOutputHelper and generate deprecations out of it'
+      task :record_from_ci_output do
+        raw_file = ENV.fetch('FILEPATH')
+
+        deprecations = extract_deprecations_output(raw_file) do |file|
+          parse_file(file)
+        end
+
+        generate_deprecations_file(deprecations)
+      end
+    end
+  end
+
+  private
+
+  def extract_deprecations_output(file)
+    tmp_file = Tempfile.new
+    shell_command = "cat #{file} | sed -n -e 's/^.* \\[DeprecationToolkit\\] \\(.*\\)/\\1/p' > #{tmp_file.path}"
+
+    raise "Couldn't extract deprecations from output" unless system(shell_command)
+    yield(tmp_file)
+  ensure
+    tmp_file.delete
+  end
+
+  def parse_file(file)
+    file.each.with_object({}) do |line, hash|
+      hash.deep_merge!(JSON.parse(line))
+    end
+  end
+
+  def generate_deprecations_file(deprecations_to_record)
+    deprecations_to_record.each do |filename, deprecations|
+      write(Pathname(filename), deprecations)
+    end
+  end
+end
+
+CIRecorder.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deprecation_toolkit
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-22 00:00:00.000000000 Z
+date: 2019-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -90,6 +90,7 @@ files:
 - gemfiles/activesupport_5.2.gemfile
 - gemfiles/test/deprecations
 - lib/deprecation_toolkit.rb
+- lib/deprecation_toolkit/behaviors/ci_record_helper.rb
 - lib/deprecation_toolkit/behaviors/disabled.rb
 - lib/deprecation_toolkit/behaviors/raise.rb
 - lib/deprecation_toolkit/behaviors/record.rb
@@ -101,6 +102,7 @@ files:
 - lib/deprecation_toolkit/version.rb
 - lib/deprecation_toolkit/warning.rb
 - lib/minitest/deprecation_toolkit_plugin.rb
+- lib/tasks/ci_recorder.rake
 - shipit.rubygems.yml
 homepage: https://github.com/shopify/deprecation_toolkit
 licenses: