awspec 1.24.3 → 1.25.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ac14ec851ce396f40316106c3784538793a8522009cc6d2172b71d01bc16691
-  data.tar.gz: 291660659e3c9223777f70e779c1d2ab34a591a4bfd83590002764977a70e73d
+  metadata.gz: 02cc903214e73de4d0d6ed6bee30b9bf987e9f5ef11387b17686ecb92675aae8
+  data.tar.gz: e890b372efb87f544a31a91caa358a6a313293edebb7fb66a24dd29fa636b34e
 SHA512:
-  metadata.gz: 411f890f896ba013a75805159318bca637f0c43f0cc2b62c9e745d3b3386a31ba24d2080c1f4821f6fd68d5392bd1003a03838f119fa156b28f1959d4016ef98
-  data.tar.gz: f9ee6a4015f25bb56b85ae3a741a628bc5985b4e85f04e92099faaa9fb14caf02d7e8a13ef6ec86e3e5cd51455fe0b1d7d6fcc6feed3853d88661233f4079afd
+  metadata.gz: db38f329352a2488a4fafc1c3f324f6653addb8e05585c90cf0644cacb64e75712cb14ac9095f7ca85c465606e9460f262e2438613ff844d99a5aaee79d3b3d8
+  data.tar.gz: 4655fa571461a651b73c6afd85aabff2c26ccdad639609b6f51a12df3fe09f8df3330d7b7909a67cfafc5c3dd8a89d85be118e17cf2c13ed4d575c95c54ba0de

data/.github/workflows/ci.yml

@@ -0,0 +1,67 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1
+        bundler-cache: true
+
+    - name: Run rubocop
+      uses: reviewdog/action-rubocop@v1
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        reporter: github-pr-review
+        fail_on_error: true
+
+  test:
+    name: Test
+    needs: [ lint ]
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - '2.1'
+          - '2.2'
+          - '2.3'
+          - '2.4'
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+    runs-on: ubuntu-latest
+    env:
+      DISABLE_AWS_CLIENT_CHECK: true
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+
+    - name: Show Ruby version
+      run: ruby -v
+
+    - name: Generate document
+      run: bundle exec bin/toolbox docgen > doc/resource_types.md
+
+    - name: Run tests
+      run: bundle exec rake spec

data/.github/workflows/doc.yml

@@ -0,0 +1,29 @@
+name: Doc
+
+on:
+  schedule:
+    - cron:  '0 0 * * 0'
+
+jobs:
+  doc:
+    name: Document
+    runs-on: ubuntu-latest
+    env:
+      DISABLE_AWS_CLIENT_CHECK: true
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '2.7'
+        bundler-cache: true
+
+    - name: Generate document
+      run: bundle exec bin/toolbox docgen > doc/resource_types.md
+
+    - uses: EndBug/add-and-commit@v7
+      with:
+        default_author: github_actions
+        add: 'doc/resource_types.md'

data/.rubocop.yml

@@ -1,23 +1,53 @@
 AllCops:
-  TargetRubyVersion: 2.1
+  SuggestExtensions: false
 
-Layout/IndentHeredoc:
+Layout/ClosingHeredocIndentation:
   Enabled: false
 
-Layout/MultilineOperationIndentation:
+Layout/HashAlignment:
   Enabled: false
 
-Layout/MultilineMethodCallBraceLayout:
+Layout/HeredocIndentation:
+  Enabled: false
+  
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/awspec/type/codedeploy_deployment_group.rb'
+    - 'lib/awspec/type/ecs_container_instance.rb'
+    - 'lib/awspec/type/ecs_service.rb'
+    - 'lib/awspec/type/eks_nodegroup.rb'
+    - 'lib/awspec/type/resource_base.rb'
+
+Lint/ErbNewArguments:
   Enabled: false
 
-Lint/HandleExceptions:
+Lint/MissingCopEnableDirective:
   Enabled: false
 
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/awspec/generator/doc/type/account_attribute.rb'
+    - 'lib/awspec/generator/doc/type/account_attribute_base.rb'
+    - 'lib/awspec/type/account_attribute.rb'
+    - 'lib/awspec/type/resource_base.rb'
+
+Lint/SuppressedException:
+  Exclude:
+    - 'Rakefile'
+
+Lint/UnreachableLoop:
+  Exclude:
+    - 'lib/awspec/type/nat_gateway.rb'
+    - 'lib/awspec/type/route53_hosted_zone.rb'
+
 Lint/UselessAssignment:
   Enabled: false
 
 Metrics/AbcSize:
-  Max: 50
+  Max: 60
 
 Metrics/BlockLength:
   Max: 60
@@ -26,48 +56,72 @@ Metrics/ClassLength:
   Max: 130
 
 Metrics/CyclomaticComplexity:
-  Max: 15
-
-Metrics/LineLength:
-  Max: 120
+  Max: 30
 
 Metrics/MethodLength:
   Max: 30
 
 Metrics/ModuleLength:
-  CountComments: false
   Max: 200
 
+Metrics/ParameterLists:
+  MaxOptionalParameters: 4
+
 Metrics/PerceivedComplexity:
-  Max: 15
+  Max: 30
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/awspec/generator/spec/security_group.rb'
+    - 'lib/awspec/helper/client_wrap.rb'
+    - 'lib/awspec/type/network_acl.rb'
 
-Style/PredicateName:
+Naming/PredicateName:
   Enabled: false
 
-Performance/StringReplacement:
+Naming/VariableNumber:
   Enabled: false
 
 Security/Eval:
+  Exclude:
+    - 'lib/awspec/command/generate.rb'
+    - 'lib/awspec/generator/doc/type.rb'
+    - 'lib/awspec/helper/type.rb'
+    - 'lib/awspec/type/account.rb'
+    - 'lib/awspec/type/account_attribute.rb'
+    - 'spec/generator/doc/type_spec.rb'
+
+Style/CaseLikeIf:
   Enabled: false
 
-Style/Alias:
+Style/ClassAndModuleChildren:
   Enabled: false
 
-Style/BarePercentLiterals:
+Style/Documentation:
   Enabled: false
 
-Style/BracesAroundHashParameters:
+Style/EvalWithLocation:
   Enabled: false
 
-Style/ClassAndModuleChildren:
+Style/HashSyntax:
   Enabled: false
 
-Style/Documentation:
+Style/HashTransformKeys:
   Enabled: false
 
-Style/MethodMissing:
+Style/IfUnlessModifier:
   Enabled: false
 
+Style/MissingRespondToMissing:
+  Enabled: false
+
+Style/MixinUsage:
+  Exclude:
+    - 'lib/awspec/helper.rb'
+
 Style/MutableConstant:
   Enabled: false
 
@@ -77,17 +131,12 @@ Style/NumericLiteralPrefix:
 Style/NumericPredicate:
   Enabled: false
 
-Style/StabbyLambdaParentheses:
+Style/SafeNavigation:
   Enabled: false
 
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
-Style/RedundantSelf:
+Style/SoleNestedConditional:
   Enabled: false
 
 Style/SymbolProc:
   Enabled: false
 
-Style/YodaCondition:
-  Enabled: false

data/Gemfile

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in awspec.gemspec
 gemspec
+
+gem 'ox' if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create('3.0.0')

data/README.md

@@ -1,11 +1,9 @@
-# awspec [![Gem](https://img.shields.io/gem/v/awspec.svg)](https://rubygems.org/gems/awspec) [![Travis](https://img.shields.io/travis/k1LoW/awspec.svg)](https://travis-ci.org/k1LoW/awspec)
+# awspec [![Gem](https://img.shields.io/gem/v/awspec.svg)](https://rubygems.org/gems/awspec) [![CI](https://github.com/k1LoW/awspec/actions/workflows/ci.yml/badge.svg)](https://github.com/k1LoW/awspec/actions)
 
 ![Logo](./awspec-logo.png)
 
 RSpec tests for your AWS resources.
 
-[![Join the chat at https://gitter.im/k1LoW/awspec](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/k1LoW/awspec?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
 [Resource Types](doc/resource_types.md) | [Contributing](doc/contributing.md)
 
 ## Installation

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 begin
@@ -12,7 +14,7 @@ end
 require 'awspec'
 
 types = Awspec::Helper::Type::TYPES.map do |type|
-  'spec:' + type
+  "spec:#{type}"
 end
 
 if defined?(RSpec)
@@ -23,14 +25,13 @@ if defined?(RSpec)
                'spec:core',
                'spec:generator_spec',
                'spec:generator_doc',
-               'spec:rubocop',
                'spec:helper']
 
     task type: types
 
     Awspec::Helper::Type::TYPES.map do |type|
       RSpec::Core::RakeTask.new(type) do |t|
-        t.pattern = 'spec/type/' + type + '_spec.rb'
+        t.pattern = "spec/type/#{type}_spec.rb"
       end
     end
 
@@ -60,5 +61,5 @@ end
 
 task :generate_docs do
   docs = Awspec::Generator::Doc::Type.generate_doc
-  File.write('doc/resource_types.md', docs + "\n")
+  File.write('doc/resource_types.md', "#{docs}\n")
 end

data/awspec.gemspec

@@ -1,6 +1,6 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'awspec/version'
 
@@ -21,18 +21,18 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.1'
-  spec.add_runtime_dependency 'aws-sdk', '~> 3'
+  spec.add_runtime_dependency 'addressable'
   spec.add_runtime_dependency 'awsecrets', '~> 1'
+  spec.add_runtime_dependency 'aws-sdk', '~> 3'
   spec.add_runtime_dependency 'dry-inflector'
   spec.add_runtime_dependency 'ipaddress'
   spec.add_runtime_dependency 'rspec', '~> 3.0'
   spec.add_runtime_dependency 'rspec-its'
   spec.add_runtime_dependency 'term-ansicolor'
   spec.add_runtime_dependency 'thor'
-  spec.add_runtime_dependency 'addressable'
   spec.add_development_dependency 'bundler', '>= 1.9', '< 3.0'
   spec.add_development_dependency 'octorelease'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rubocop', '~> 0.49.0'
+  spec.add_development_dependency 'rubocop'
 end

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'awspec'

data/bin/toolbox

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'awspec'
 

data/doc/_resource_types/cloudwatch_logs.md

@@ -21,6 +21,15 @@ describe cloudwatch_logs('my-cloudwatch-logs-group') do
   it { should have_metric_filter('my-cloudwatch-logs-metric-filter') }
 end
 ```
+or
+```ruby
+describe cloudwatch_logs('my-cloudwatch-logs-group') do
+  it do
+    should have_metric_filter('my-cloudwatch-logs-metric-filter')
+      .filter_pattern('[date, error]')
+ end
+end
+```
 
 ### have_subscription_filter
 

data/doc/_resource_types/eks_nodegroup.md

@@ -5,6 +5,25 @@ describe eks_nodegroup('my-eks-nodegroup'), cluster: 'my-cluster' do
   it { should exist }
 end
 ```
+
+### have_security_group
+
+```ruby
+describe eks_nodegroup('my-eks-nodegroup'), cluster: 'my-cluster' do
+  it { should have_security_group('sg-1a2b3cd4') }
+end
+```
+
+### scaling_config
+
+```ruby
+describe eks_nodegroup('my-eks-nodegroup'), cluster: 'my-cluster' do
+  its('scaling_config.min_size') { should eq 1 }
+  its('scaling_config.desired_size') { should eq 2 }
+  its('scaling_config.max_size') { should eq 3 }
+end
+```
+
 ### be_active, be_creating
 
 ```ruby
@@ -12,3 +31,37 @@ describe eks('my-eks-nodegroup'), cluster: 'my-cluster' do
   it { should be_active }
 end
 ```
+
+### be_ready
+
+This matcher *might* not be exactly you are expecting: it is different from what
+you can see when looking at the AWS console at the Node Groups configuration
+and check if the nodes Status is "Ready".
+
+What you seeing over there is
+[actually the same thing](https://aws.amazon.com/premiumsupport/knowledge-center/eks-node-status-ready/)
+you would if using `kubectl`.
+
+This matcher cannot do the same because it would involve using the Kubernetes
+API: the AWS Ruby SDK currently doesn't expose this information.
+
+What you can get from `be_ready` matcher is asserting that you have **at least**
+the number of EC2 instances (the nodes in your EKS Node Group) are actually
+in running state. It doesn't mean everything is fine, the node (EC2 instance)
+can be running but without communication with the cluster or any order issue
+regarding the Kubernetes configuration.
+
+Although it might look an incomplete assertion, definitely the Node Group
+"Status" won't be "Active" if the EC2 instances associated with it are not
+running.
+
+So, using this assertion like the sample below:
+
+```ruby
+describe eks('my-eks-nodegroup'), cluster: 'my-cluster' do
+  it { should be_ready }
+end
+```
+
+Will pass if at least the minimum expected (see `scaling_config`) number of EC2
+instances are running.