Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(bug) Correctly compute Cache ID for plugin invocations #2487

Merged
merged 1 commit into from
Dec 16, 2020
Merged

(bug) Correctly compute Cache ID for plugin invocations #2487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/bolt/plugin/cache.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ def read_and_clean_cache

# Luckily we don't need to use a serious hash algorithm
require 'digest/bubblebabble'
r = reference.select { |k, _| k == '_cache' }.sort.to_s
r = reference.reject { |k, _| k == '_cache' }.sort.to_s
@id = Digest::SHA2.bubblebabble(r)[0..20]

unmodified = true
Expand Down
21 changes: 11 additions & 10 deletions spec/bolt/plugin/cache_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@
require 'bolt/plugin/cache'

describe Bolt::Plugin::Cache do
let(:reference) {
{ '_plugin' => 'task',
'task' => 'env_plugin::resolve_reference',
let(:env_var) { 'BOLT_TEST_PLUGIN_VALUE' }
let(:reference) do
{ '_plugin' => 'env_var',
'var' => env_var,
'_cache' => { 'ttl' => 120 } }
}
end
let(:plugin_cache) { Bolt::Plugin::Cache.new(reference, @tmpfile, {}) }

around :each do |example|
Expand All @@ -21,8 +22,8 @@
context "#validate" do
context "if _cache is not a Hash" do
let(:reference) {
{ '_plugin' => 'task',
'task' => 'env_plugin::resolve_reference',
{ '_plugin' => 'env_var',
'var' => env_var,
'_cache' => 120 }
}
it "fails" do
Expand All @@ -33,8 +34,8 @@

context "if _cache does not have a ttl key" do
let(:reference) {
{ '_plugin' => 'task',
'task' => 'env_plugin::resolve_reference',
{ '_plugin' => 'env_var',
'var' => env_var,
'_cache' => { 'tl' => 120 } }
}
it "fails" do
Expand All @@ -47,8 +48,8 @@
context "#read_and_clean_cache" do
context "with ttl 0" do
let(:reference) {
{ '_plugin' => 'task',
'task' => 'env_plugin::resolve_reference',
{ '_plugin' => 'env_var',
'var' => env_var,
'_cache' => { 'ttl' => 0 } }
}

Expand Down
1 change: 0 additions & 1 deletion spec/fixtures/plugin_modules/env_plugin/bolt_plugin.json
View file
Open in desktop

This file was deleted.

3 changes: 0 additions & 3 deletions spec/fixtures/plugin_modules/env_plugin/tasks/resolve_reference.json
View file
Open in desktop

This file was deleted.

6 changes: 0 additions & 6 deletions spec/fixtures/plugin_modules/env_plugin/tasks/resolve_reference.rb
View file
Open in desktop

This file was deleted.

103 changes: 75 additions & 28 deletions spec/integration/cache_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@
include BoltSpec::Integration
include BoltSpec::Project

let(:project) { @project }
let(:project_path) { @project.path }
let(:inventory) { nil }
let(:project) { @project }
let(:project_path) { @project.path }
let(:inventory) { nil }
let(:user_env_var) { 'BOLT_USER_PLUGIN_VALUE' }
let(:tmpdir_env_var) { 'BOLT_PORT_PLUGIN_VALUE' }
let(:mpath) { fixtures_path('plugin_modules') }
let(:plan) do
<<~PLAN
Expand All @@ -22,30 +24,72 @@
PLAN
end

def plugin(ttl: 120, env_var: user_env_var)
{
'_plugin' => 'env_var',
'var' => env_var,
'_cache' => { 'ttl' => ttl }
}
end

around(:each) do |example|
with_project('cache_test', inventory: inventory) do |project|
@project = project

ENV['BOLT_TEST_PLUGIN_VALUE'] = 'player_one'
if plan
FileUtils.mkdir_p(File.join(project_path, 'plans'))
File.write(File.join(project_path, 'plans', 'init.pp'), plan)
end
ENV[user_env_var] = 'player_one'
ENV[tmpdir_env_var] = '/tmp'
FileUtils.mkdir_p(File.join(project_path, 'plans'))
File.write(File.join(project_path, 'plans', 'init.pp'), plan)

example.run
end
end

context 'refreshing cache' do
let(:plugin) {
{
'_plugin' => 'task',
'task' => 'env_plugin::resolve_reference',
'_cache' => { 'ttl' => 120 }
}
}
context 'setting cache' do
let(:inventory) do
{ 'targets' => [
{ 'uri' => 'node1',
'config' => {
'ssh' => {
'user' => plugin,
'password' => plugin(ttl: 20)
}
} }
] }
end

let(:inventory) {
it 'sets a unique ID based on the plugin hash minus the _cache' do
run_cli(%W[plan run cache_test --project #{project_path} -m #{mpath}])
# This should set a unique ID for each different `env_var`, but not
# different `cache` values
expect(JSON.parse(File.read(project.cache_file)).keys)
.to eq(%w[xihev-zaper-kerel-hyl])
end

context 'with plugins with different parameters' do
let(:inventory) do
{ 'targets' => [
{ 'uri' => 'node1',
'config' => {
'ssh' => {
'user' => plugin,
'password' => plugin(ttl: 20),
'tmpdir' => plugin(env_var: tmpdir_env_var)
}
} }
] }
end

it 'sets a unique ID based on the plugin hash minus the _cache' do
run_cli(%W[plan run cache_test --project #{project_path} -m #{mpath}])
expect(JSON.parse(File.read(project.cache_file)).keys)
.to eq(%w[xihev-zaper-kerel-hyl xekin-reryb-tacuf-dis])
end
end
end

context 'refreshing cache' do
let(:inventory) do
{ 'targets' => [
{ 'uri' => 'node1',
'config' => {
Expand All @@ -54,14 +98,14 @@
}
} }
] }
}
end

it 'removes the existing cache file with --clear-cache' do
run_cli(%W[plan run cache_test --project #{project_path} -m #{mpath}])
expect(JSON.parse(File.read(project.cache_file)).values.first)
.to include({ 'result' => 'player_one' })

ENV['BOLT_TEST_PLUGIN_VALUE'] = 'player_two'
ENV[user_env_var] = 'player_two'

result = run_cli(%W[plan run cache_test --project #{project_path} -m #{mpath} --clear-cache])
expect(JSON.parse(result)).to eq('player_two')
Expand All @@ -72,26 +116,29 @@
expect(JSON.parse(File.read(project.cache_file)).values.first)
.to include({ 'result' => 'player_one' })

ENV['BOLT_TEST_PLUGIN_VALUE'] = 'player_two'
ENV[user_env_var] = 'player_two'

result = run_cli(%W[plan run cache_test --project #{project_path} -m #{mpath}])
expect(JSON.parse(result)).to eq('player_one')
end

context 'with a short ttl' do
let(:plugin) {
{
'_plugin' => 'task',
'task' => 'env_plugin::resolve_reference',
'_cache' => { 'ttl' => 0 }
}
}
let(:inventory) do
{ 'targets' => [
{ 'uri' => 'node1',
'config' => {
'ssh' => {
'user' => plugin(ttl: 0)
}
} }
] }
end

it 'removes cache entries once the ttl has expired' do
run_cli(%W[plan run cache_test --project #{project_path} -m #{mpath}])
expect(JSON.parse(File.read(project.cache_file)).values.first)
.to include({ 'result' => 'player_one' })
ENV['BOLT_TEST_PLUGIN_VALUE'] = 'player_two'
ENV[user_env_var] = 'player_two'
result = run_cli(%W[plan run cache_test --project #{project_path} -m #{mpath}])
expect(JSON.parse(result)).to eq('player_two')
end
Expand Down