Class: PactBroker::DB::CleanTask

Inherits:
Rake::TaskLib
  • Object
show all
Defined in:
lib/pact_broker/tasks/clean_task.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(&block) ⇒ CleanTask

Returns a new instance of CleanTask.



20
21
22
23
24
25
26
27
28
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 20

def initialize &block
  require "pact_broker/db/clean_incremental"
  @version_deletion_limit = 1000
  @dry_run = false
  @use_lock = true
  @keep_version_selectors = PactBroker::DB::CleanIncremental::DEFAULT_KEEP_SELECTORS
  @keep_branch_selectors = PactBroker::DB::CleanIncremental::DEFAULT_KEEP_BRANCH_SELECTORS
  rake_task(&block)
end

Instance Attribute Details

#branch_deletion_limit ⇒ Object

Returns the value of attribute branch_deletion_limit.



15
16
17
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 15

def branch_deletion_limit
  @branch_deletion_limit
end

#database_connection ⇒ Object

Returns the value of attribute database_connection.



11
12
13
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 11

def database_connection
  @database_connection
end

#dry_run ⇒ Object

Returns the value of attribute dry_run.



17
18
19
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 17

def dry_run
  @dry_run
end

#keep_branch_selectors ⇒ Object

Returns the value of attribute keep_branch_selectors.



13
14
15
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 13

def keep_branch_selectors
  @keep_branch_selectors
end

#keep_version_selectors ⇒ Object

Returns the value of attribute keep_version_selectors.



12
13
14
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 12

def keep_version_selectors
  @keep_version_selectors
end

#logger ⇒ Object

Returns the value of attribute logger.



16
17
18
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 16

def logger
  @logger
end

#use_lock ⇒ Object

allow disabling of postgres lock if it is causing problems



18
19
20
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 18

def use_lock
  @use_lock
end

#version_deletion_limit ⇒ Object

Returns the value of attribute version_deletion_limit.



14
15
16
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 14

def version_deletion_limit
  @version_deletion_limit
end

Instance Method Details

#add_defaults_to_keep_selectors ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 134

def add_defaults_to_keep_selectors
  if keep_version_selectors.none?(&:currently_deployed?)
    selector = PactBroker::DB::Clean::Selector.new(deployed: true)
    output("Automatically adding #{selector.to_hash} to keep version selectors")
    keep_version_selectors << selector
  end

  if keep_version_selectors.none?(&:currently_supported?)
    selector = PactBroker::DB::Clean::Selector.new(released: true)
    output("Automatically adding #{ selector.to_hash } to keep version selectors")
    keep_version_selectors << selector
  end
end

#output(string, payload = {}) ⇒ Object 



121
122
123
124
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 121

def output(string, payload = {})
  prefix = dry_run ? "[DRY RUN] " : ""
  logger ? logger.info("#{prefix}#{string}", payload) : puts("#{prefix}#{string} #{payload.to_json}")
end

#output_keep_branch_selectors ⇒ Object 



126
127
128
129
130
131
132
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 126

def output_keep_branch_selectors
  if keep_branch_selectors.nil? || keep_branch_selectors.empty?
    output "Stale branch cleanup is disabled (no keep_branch_selectors configured)"
  else
    output "Deleting stale branches that do not match the configured selectors (main branches are always kept)", keep_branch_selectors.collect(&:to_hash)
  end
end

#perform_clean ⇒ Object

Raises:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 59

def perform_clean
  require "pact_broker/db/clean_incremental"
  require "pact_broker/error"
  require "yaml"
  require "benchmark"

  raise PactBroker::Error.new("You must specify the version_deletion_limit") unless version_deletion_limit

  if keep_version_selectors.nil? || keep_version_selectors.empty?
    raise PactBroker::Error.new("You must specify which versions to keep")
  else
    add_defaults_to_keep_selectors
    output "Deleting oldest #{version_deletion_limit} versions, keeping versions that match the configured selectors", keep_version_selectors.collect(&:to_hash)
  end

  output_keep_branch_selectors

  start_time = Time.now
  results = PactBroker::DB::CleanIncremental.call(database_connection,
    keep: keep_version_selectors,
    keep_branches: keep_branch_selectors,
    limit: version_deletion_limit,
    branch_limit: branch_deletion_limit,
    logger: logger,
    dry_run: dry_run
  )
  end_time = Time.now
  elapsed_seconds = (end_time - start_time).to_i
  output "Results (#{elapsed_seconds} seconds)", results
end

#rake_task(&block) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 44

def rake_task &block
  namespace :pact_broker do
    namespace :db do
      desc "Clean unnecessary pacts, verifications and stale branches from database"
      task :clean do | _t, _args |
        instance_eval(&block)

        with_lock do
          perform_clean
        end
      end
    end
  end
end

#with_lock ⇒ Object

Use a Postgres advisory lock to ensure that only one clean can run at a time. This allows a cron schedule to be used on the Pact Broker Docker image when deployed on a multi-instance architecture, without all the instances stepping on each other's toes.

Any tasks that attempt to run while a clean job is running will skip the clean and exit with a message and a success code.

To test that the lock works, run:

script/docker/db-start.sh
script/docker/db-migrate.sh
for i in {0..3}; do PACT_BROKER_TEST_DATABASE_URL=postgres://postgres:postgres@localhost/postgres bundle exec rake pact_broker:db:clean &;  done;

There will be 3 messages saying "Clean was not performed" and output from one thread showing the clean is being done.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/pact_broker/tasks/clean_task.rb', line 103

def with_lock
  if use_lock
    require "pact_broker/db/advisory_lock"

    lock = PactBroker::DB::AdvisoryLock.new(database_connection, :clean, :pg_try_advisory_lock)
    results = lock.with_lock do
      yield
    end

    if !lock.lock_obtained?
      output("Clean was not performed as a clean is already in progress. Exiting.")
    end
    results
  else
    yield
  end
end