Skip to content

Fix matchers to align with waiters SEP #3242

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

Merged
merged 10 commits into from
May 21, 2025
Merged

Fix matchers to align with waiters SEP #3242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
09a0037
Add examples of currently failing cases
richardwang1124 May 5, 2025
3cea830
Remove puts
richardwang1124 May 5, 2025
bb1035d
Rever poller changes
richardwang1124 May 5, 2025
a0ceb63
Add changelog entry
richardwang1124 May 5, 2025
2f78a8a
Add more test cases for path matchers
richardwang1124 May 8, 2025
9ce40ea
Preprocess object expected values
richardwang1124 May 9, 2025
42bc4bc
Changelog message update
richardwang1124 May 9, 2025
92a351a
Make compatible with older ruby versions
richardwang1124 May 9, 2025
4a97252
Changes from PR comments
richardwang1124 May 16, 2025
1b44334
Remove table concepts from tests
richardwang1124 May 19, 2025
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
24 changes: 24 additions & 0 deletions build_tools/aws-sdk-code-generator/lib/aws-sdk-code-generator/waiter.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ def acceptors(acceptors)
acceptor['argument']
)
end
acceptor['expected'] = convert_value(acceptor['expected'])
end
HashFormatter.new(
wrap: false,
Expand All @@ -90,6 +91,29 @@ def acceptors(acceptors)
).format(acceptors: acceptors)
end

def convert_value(value)
case value
when Hash then convert_keys(value)
when Array then convert_array(value)
else value
end
end

# Underscore and symbolize all keys in hash
def convert_keys(hash)
hash.each_with_object({}) do |(key, value), result|
result[convert_key(key)] = convert_value(value)
end
end

def convert_key(key)
key.is_a?(String) ? Underscore.underscore(key).to_sym : key
end

# Convert keys for every object in array
def convert_array(array)
array.collect { |elem| convert_value(elem) }
end
end
end
end
198 changes: 180 additions & 18 deletions gems/aws-sdk-core/spec/aws/waiters_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,15 +89,15 @@ module Waiters
end

it 'returns when successful' do
client.stub_responses(:waiter_operation, table: { table_status: 'ACTIVE' })
client.stub_responses(:waiter_operation, complex_object: { string_member: 'expected' })
expect { client.wait_until(:generic_waiter) }
.not_to raise_error
end

it 'returns the client response' do
client.stub_responses(:waiter_operation, table: { table_status: 'ACTIVE' })
client.stub_responses(:waiter_operation, complex_object: { string_member: 'expected' })
resp = client.wait_until(:generic_waiter)
expect(resp.table.table_status).to eq('ACTIVE')
expect(resp.complex_object.string_member).to eq('expected')
end

it 'raises an error when failed' do
Expand Down Expand Up @@ -231,22 +231,22 @@ module Waiters
client.stub_responses(
:waiter_operation,
'ResourceNotFoundException',
{ table: { table_status: 'ACTIVE' } }
{ complex_object: { string_member: 'expected' } }
)
expect { client.wait_until(:error_matcher_with_false) }
.not_to raise_error
end

it 'fails when matched' do
client.stub_responses(:waiter_operation, table: { table_status: 'ACTIVE' })
client.stub_responses(:waiter_operation, complex_object: { string_member: 'expected' })
expect { client.wait_until(:error_matcher_with_false_fails) }
.to raise_error(Errors::WaiterFailed)
end

it 'retries when matched' do
client.stub_responses(
:waiter_operation,
{ table: { table_status: 'ACTIVE' } },
{ complex_object: { string_member: 'expected' } },
'ResourceNotFoundException'
)
retries = 0
Expand All @@ -261,8 +261,8 @@ module Waiters
it 'retries and succeed when matched' do
client.stub_responses(
:waiter_operation,
{ table: { table_status: 'UPDATING' } },
{ table: { table_status: 'ACTIVE' } }
{ complex_object: { string_member: 'retry' } },
{ complex_object: { string_member: 'expected' } }
)
retries = 0
expect do
Expand All @@ -272,18 +272,86 @@ module Waiters
end

it 'fails when matched' do
client.stub_responses(:waiter_operation, table: { table_status: 'FAILED' })
client.stub_responses(:waiter_operation, complex_object: { string_member: 'unexpected' })
expect { client.wait_until(:path_matcher) }
.to raise_error(Errors::FailureStateError)
end

it 'can match objects' do
object = {
object_member: { string_member: 'string' },
string_member: 'string',
number_member: 1,
boolean_member: true,
array_member: [1, 2, 3],
object_array_member: [
{
object_member: { string_member: 'string' },
string_member: 'string'
}
]
}
client.stub_responses(:waiter_operation, complex_object: object)
expect { client.wait_until(:path_matcher_object) }
.to_not raise_error
end

it 'can match numbers' do
resp = {
object_list: [
{ string_member: 'expected' },
{ string_member: 'expected' },
{ string_member: 'expected' }
]
}
client.stub_responses(:waiter_operation, resp)
expect { client.wait_until(:path_matcher_number) }
.to_not raise_error
end

it 'can match arrays' do
client.stub_responses(:waiter_operation, number_list: [1, 2, 3])
expect { client.wait_until(:path_matcher_array) }
.to_not raise_error
end

it 'can match array of objects' do
list = [
{
object_member: { string_member: 'string' },
string_member: 'string',
number_member: 1,
boolean_member: true,
array_member: [1, 2, 3],
object_array_member: [
{
object_member: { string_member: 'string' },
string_member: 'string'
}
]
},
{
object_member: { string_member: 'string' }
}
]
client.stub_responses(:waiter_operation, object_list: list)
expect { client.wait_until(:path_matcher_object_array) }
.to_not raise_error
end

it 'can match booleans' do
client.stub_responses(:waiter_operation, boolean: false)
expect { client.wait_until(:path_matcher_boolean) }
.to_not raise_error
end
end

context 'pathAll' do
it 'retries and succeed when matched' do
client.stub_responses(
:waiter_operation,
{ table_list: [{ table_status: 'UPDATING' }] },
{ table_list: [{ table_status: 'ACTIVE' }] }
{ object_list: [{ string_member: 'retry' }] },
{ object_list: [{ string_member: 'expected' }] }
)
retries = 0
expect do
Expand All @@ -292,10 +360,37 @@ module Waiters
expect(retries).to be(1)
end

it 'can match array of objects' do
client.stub_responses(
:waiter_operation,
object_list: [{ string_member: 'expected' }, { string_member: 'expected' }]
)
expect { client.wait_until(:path_all_matcher_object) }
.to_not raise_error
end

it 'can match array of numbers' do
client.stub_responses(:waiter_operation, number_list: [123, 123, 123])
expect { client.wait_until(:path_all_matcher_number) }
.to_not raise_error
end

it 'can match array of arrays' do
client.stub_responses(:waiter_operation, nested_list: [[1, 2, 3], [1, 2, 3], [1, 2, 3]])
expect { client.wait_until(:path_all_matcher_array) }
.to_not raise_error
end

it 'can match array of booleans' do
client.stub_responses(:waiter_operation, boolean_list: [false, false, false])
expect { client.wait_until(:path_all_matcher_boolean) }
.to_not raise_error
end

it 'fails when matched' do
client.stub_responses(
:waiter_operation,
table_list: [{ table_status: 'FAILED' }]
object_list: [{ string_member: 'unexpected' }]
)
expect { client.wait_until(:path_all_matcher) }
.to raise_error(Errors::FailureStateError)
Expand All @@ -304,7 +399,7 @@ module Waiters
it 'fails when none are matched' do
client.stub_responses(
:waiter_operation,
table_list: [{ table_status: 'UPDATING' }, { table_status: 'ACTIVE' }]
object_list: [{ string_member: 'retry' }, { string_member: 'expected' }]
)
expect { client.wait_until(:path_all_matcher) }
.to raise_error(Errors::TooManyAttemptsError)
Expand All @@ -313,7 +408,27 @@ module Waiters
it 'fails when none of the path matches' do
client.stub_responses(
:waiter_operation,
table_list: [{ table_status: 'UPDATING' }, { table_status: 'ACTIVE' }]
object_list: [{ string_member: 'retry' }, { string_member: 'expected' }]
)
expect do
client.wait_until(:path_all_matcher) { |w| w.max_attempts = 1 }
end.to raise_error(Errors::TooManyAttemptsError)
end

it 'fails when array is empty' do
client.stub_responses(
:waiter_operation,
object_list: []
)
expect do
client.wait_until(:path_all_matcher) { |w| w.max_attempts = 1 }
end.to raise_error(Errors::TooManyAttemptsError)
end

it 'fails when array is nil' do
client.stub_responses(
:waiter_operation,
object_list: nil
)
expect do
client.wait_until(:path_all_matcher) { |w| w.max_attempts = 1 }
Expand All @@ -325,8 +440,8 @@ module Waiters
it 'retries and succeed when matched' do
client.stub_responses(
:waiter_operation,
{ table_list: [{ table_status: 'UPDATING' }, { table_status: 'CREATING' }] },
{ table_list: [{ table_status: 'ACTIVE' }, { table_status: 'CREATING' }] }
{ object_list: [{ string_member: 'retry' }, { string_member: 'other' }] },
{ object_list: [{ string_member: 'expected' }, { string_member: 'retry' }] }
)
retries = 0
expect do
Expand All @@ -335,10 +450,37 @@ module Waiters
expect(retries).to be(1)
end

it 'can match array of objects' do
client.stub_responses(
:waiter_operation,
object_list: [{ string_member: 'unexpected' }, { string_member: 'expected' }]
)
expect { client.wait_until(:path_any_matcher_object) }
.to_not raise_error
end

it 'can match array of numbers' do
client.stub_responses(:waiter_operation, number_list: [456, 789, 123])
expect { client.wait_until(:path_any_matcher_number) }
.to_not raise_error
end

it 'can match array of arrays' do
client.stub_responses(:waiter_operation, nested_list: [[4, 5, 6], [1, 2, 3], [7, 8, 9]])
expect { client.wait_until(:path_any_matcher_array) }
.to_not raise_error
end

it 'can match array of booleans' do
client.stub_responses(:waiter_operation, boolean_list: [true, false, true])
expect { client.wait_until(:path_any_matcher_boolean) }
.to_not raise_error
end

it 'fails when matched' do
client.stub_responses(
:waiter_operation,
{ table_list: [{ table_status: 'FAILED' }, { table_status: 'CREATING' }] }
{ object_list: [{ string_member: 'unexpected' }, { string_member: 'retry' }] }
)
expect { client.wait_until(:path_any_matcher) }
.to raise_error(Errors::FailureStateError)
Expand All @@ -347,11 +489,31 @@ module Waiters
it 'fails when none of the path matches' do
client.stub_responses(
:waiter_operation,
table_list: [{ table_status: 'CREATING' }, { table_status: 'FOO' }]
object_list: [{ string_member: 'other' }, { string_member: 'other' }]
)
expect { client.wait_until(:path_any_matcher) }
.to raise_error(Errors::TooManyAttemptsError)
end

it 'fails when array is empty' do
client.stub_responses(
:waiter_operation,
object_list: []
)
expect do
client.wait_until(:path_any_matcher) { |w| w.max_attempts = 1 }
end.to raise_error(Errors::TooManyAttemptsError)
end

it 'fails when array is nil' do
client.stub_responses(
:waiter_operation,
object_list: nil
)
expect do
client.wait_until(:path_any_matcher) { |w| w.max_attempts = 1 }
end.to raise_error(Errors::TooManyAttemptsError)
end
end
end
end
Expand Down
Loading
Loading