pact_broker 2.70.0 → 2.71.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b57a2f04694ce119675cd5b4fb647e1c2faff71b890958391ca30846ef0d7fab
-  data.tar.gz: 8b6484329b0821600417fc17ad564a14de06edf2edc21939423c34ea2795cee1
+  metadata.gz: a7fe157577be6cdfb603e4607b174224781db0b9b2ee7ccb1325cdda50ce129d
+  data.tar.gz: 9e28ef38f281ac6d6dbf1879d3794a8f915cb78bb8a82c464c7273ac9f8522dc
 SHA512:
-  metadata.gz: e4d1c82adbbb041f38d64200ccb0f1fc8d4672f3a9e445db0dcf428b25c8353c5922a3fb579b74560114df476886fb8aee93d2b793643ae9bbbbd8f786fec443
-  data.tar.gz: dc130a9cea4a62c741c401290b385f807c4597073a1ae467d3b334bd058267eca2179ebb6be60d53c2f6cf7046c7b567edf473738a2642e122d1c6e40938301a
+  metadata.gz: 3e5d4d249f691a3e03725e3b827f4044eb2fde360cd0dd9128fce61a4442288083f825f654473cf1a3220745460675036951242cc801211eda258369e38eeb09
+  data.tar.gz: f8b9f3bdbfe42ca21291b41588ae4b3be15ca53efaec275e5356d8363dfa181e592942cb5e13bbd492fadb61d231cee68aaed009fef559c0645bc4debc4137c1

data/.github/workflows/test.yml

@@ -3,6 +3,18 @@ name: Test
 on: push
 
 jobs:
+  sqlite:
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        ruby_version: ["2.7"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - run: "bundle install"
+      - run: "bundle exec rake"
   postgres:
     runs-on: "ubuntu-latest"
     strategy:
@@ -36,7 +48,7 @@ jobs:
     runs-on: "ubuntu-latest"
     strategy:
       matrix:
-        ruby_version: ["2.5", "2.7"]
+        ruby_version: ["2.7"]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-ruby@v1

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+<a name="v2.71.0"></a>
+### v2.71.0 (2020-11-28)
+
+#### Features
+
+* allow clean to be performed in dry run mode	 ([a7a18fde](/../../commit/a7a18fde))
+
 <a name="v2.70.0"></a>
 ### v2.70.0 (2020-11-28)
 

data/lib/pact_broker/db/clean_incremental.rb

@@ -1,11 +1,11 @@
 require 'pact_broker/logging'
 require 'pact_broker/matrix/unresolved_selector'
+require 'pact_broker/date_helper'
+
 
 module PactBroker
   module DB
     class CleanIncremental
-      include PactBroker::Logging
-
       DEFAULT_KEEP_SELECTORS = [
         PactBroker::Matrix::UnresolvedSelector.new(tag: true, latest: true),
         PactBroker::Matrix::UnresolvedSelector.new(latest: true),
@@ -22,6 +22,10 @@ module PactBroker
         @options = options
       end
 
+      def logger
+        options[:logger] || PactBroker.logger
+      end
+
       def keep
         options[:keep] || DEFAULT_KEEP_SELECTORS
       end
@@ -45,16 +49,38 @@ module PactBroker
       end
 
       def call
-        require 'pact_broker/domain/version'
-        before_counts = current_counts
-
-        result = PactBroker::Domain::Version.where(id: resolve_ids(version_ids_to_delete)).delete
-        delete_orphan_pact_versions
-
-        after_counts = current_counts
-
-        TABLES.each_with_object({}) do | table_name, comparison_counts |
-          comparison_counts[table_name.to_s] = { "deleted" => before_counts[table_name] - after_counts[table_name], "kept" => after_counts[table_name] }
+        require 'pact_broker/db/models'
+
+        if dry_run?
+          to_delete = PactBroker::Domain::Version
+            .where(id: version_ids_to_delete.select(:id))
+            .all
+            .group_by{ | v | v.pacticipant_id }
+            .each_with_object({}) do | (pacticipant_id, versions), thing |
+              thing[versions.first.pacticipant.name] = {
+                count: versions.count,
+                from_version: {
+                  number: versions.first.number,
+                  created: DateHelper.distance_of_time_in_words(versions.first.created_at, DateTime.now) + " ago",
+                  tags: versions.first.tags.collect(&:name)
+                },
+                to_version: {
+                  number: versions.last.number,
+                  created: DateHelper.distance_of_time_in_words(versions.last.created_at, DateTime.now) + " ago",
+                  tags: versions.last.tags.collect(&:name)
+                }
+              }
+            end
+          { "to_delete" => to_delete }
+        else
+          before_counts = current_counts
+          result = PactBroker::Domain::Version.where(id: resolve_ids(version_ids_to_delete)).delete
+          delete_orphan_pact_versions
+          after_counts = current_counts
+
+          TABLES.each_with_object({}) do | table_name, comparison_counts |
+            comparison_counts[table_name.to_s] = { "deleted" => before_counts[table_name] - after_counts[table_name], "kept" => after_counts[table_name] }
+          end
         end
       end
 
@@ -68,8 +94,11 @@ module PactBroker
         end
       end
 
+      def dry_run?
+        options[:dry_run]
+      end
+
       def delete_orphan_pact_versions
-        logger.info("Deleting orphan pact versions")
         referenced_pact_version_ids = db[:pact_publications].select(:pact_version_id).union(db[:verifications].select(:pact_version_id))
         db[:pact_versions].where(id: referenced_pact_version_ids).invert.delete
       end

data/lib/pact_broker/tasks/clean_task.rb

@@ -5,10 +5,13 @@ module PactBroker
       attr_accessor :database_connection
       attr_reader :keep_version_selectors
       attr_accessor :version_deletion_limit
+      attr_accessor :logger
+      attr_accessor :dry_run
 
       def initialize &block
         require 'pact_broker/db/clean_incremental'
         @version_deletion_limit = 1000
+        @dry_run = false
         @keep_version_selectors = PactBroker::DB::CleanIncremental::DEFAULT_KEEP_SELECTORS
         rake_task &block
       end
@@ -38,14 +41,19 @@ module PactBroker
               if keep_version_selectors.nil? || keep_version_selectors.empty?
                 raise PactBroker::Error.new("You must specify which versions to keep")
               else
-                puts "Deleting oldest #{version_deletion_limit} versions, keeping versions that match the following selectors: #{keep_version_selectors}..."
+                output "Deleting oldest #{version_deletion_limit} versions, keeping versions that match the configured selectors", keep_version_selectors
               end
 
               start_time = Time.now
-              results = PactBroker::DB::CleanIncremental.call(database_connection, keep: keep_version_selectors, limit: version_deletion_limit)
+              results = PactBroker::DB::CleanIncremental.call(
+                database_connection, keep: keep_version_selectors, limit: version_deletion_limit, logger: logger, dry_run: dry_run)
               end_time = Time.now
               elapsed_seconds = (end_time - start_time).to_i
-              puts results.to_yaml.gsub("---", "\nResults (#{elapsed_seconds} seconds)\n-------")
+              output "Results (#{elapsed_seconds} seconds)", results
+            end
+
+            def output string, payload = {}
+              logger ? logger.info(string, payload: payload) : puts("#{string} #{payload.to_json}")
             end
           end
         end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.70.0'
+  VERSION = '2.71.0'
 end

data/spec/lib/pact_broker/db/clean_incremental_spec.rb

@@ -15,15 +15,21 @@ module PactBroker
       let(:options) { {} }
       let(:db) { PactBroker::DB.connection }
 
-      subject { CleanIncremental.call(PactBroker::DB.connection, options) }
+
       let(:latest_dev_selector) { PactBroker::Matrix::UnresolvedSelector.new(tag: "dev", latest: true) }
       let(:all_prod_selector) { PactBroker::Matrix::UnresolvedSelector.new(tag: "prod") }
       let(:limit) { 3 }
+      let(:dry_run) { false }
+
+      subject { CleanIncremental.call(PactBroker::DB.connection, options) }
 
       describe ".call"do
         context "when there are specified versions to keep" do
           before do
             td.create_pact_with_hierarchy("Foo", "1", "Bar")
+              .create_webhook
+              .create_triggered_webhook
+              .create_webhook_execution
               .create_consumer_version_tag("prod").comment("keep as one of prod")
               .create_consumer_version_tag("dev")
               .add_day
@@ -45,7 +51,7 @@ module PactBroker
               .create_pact
           end
 
-          let(:options) { { keep: [all_prod_selector, latest_dev_selector], limit: limit } }
+          let(:options) { { keep: [all_prod_selector, latest_dev_selector], limit: limit, dry_run: dry_run } }
 
           it "does not delete the consumer versions specified" do
             expect(PactBroker::Domain::Version.where(number: "1").count).to be 1
@@ -64,8 +70,20 @@ module PactBroker
             expect(PactBroker::Domain::Version.where(number: "6").count).to be 0
             expect(PactBroker::Domain::Version.where(number: "7").count).to be 1
           end
+
+          context "when dry_run: true" do
+            before do
+              td.create_pact_with_hierarchy("Meep", "2", "Moop")
+            end
+            let(:dry_run) { true }
+
+            it "doesn't delete anything" do
+              expect { subject }.to_not change { PactBroker::Domain::Version.count }
+            end
+          end
         end
 
+
         context "with orphan pact versions" do
           before do
             # Create a pact that will not be deleted

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.70.0
+  version: 2.71.0
 platform: ruby
 authors:
 - Bethany Skurrie