practice_terraforming 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4510b6b15bd49f015c16da4633554e11faed8e43
+  data.tar.gz: 07e6b2fd44fd6a531d30ed90b95c6c5eef9e8487
+SHA512:
+  metadata.gz: f33ef2d0902a23427eac11f2a922d1708987f4aadd7dd552d77e56c373b8cd75b7ad980cecad9988c6d2085c058a5a7664939f42c5ad71d8925e6db9b02afa55
+  data.tar.gz: dd33fef40a74793bd1e271c966e5f5f57534ffdc864a7152e92bad22a6737fd52379835631b51b8744f65f0d8823c3229be1dc7deef23cbdbd23659c4c5f7ea9

data/.circleci/config.yml

@@ -0,0 +1,34 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.4.2-jessie-node
+        environment:
+          BUNDLER_VERSION: 2.0.2
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            - v1-dependencies-
+      - run:
+          name: setup bundler
+          command: |
+            sudo gem update --system
+            sudo gem uninstall bundler
+            sudo rm /usr/local/bin/bundle
+            sudo rm /usr/local/bin/bundler
+            sudo gem install bundler
+      - run:
+          name: install
+          command: bundle install --path vendor/bundle
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+      - run:
+          name: rubocop
+          command: bundle exec rubocop
+      - run:
+          name: rspec
+          command: bundle exec rspec

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,93 @@
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 140
+  Exclude:
+    - "spec/**/*"
+
+# Offense count: 42
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/HashSyntax:
+  Exclude:
+    - 'Rakefile'
+
+# TODO: check again
+Style/IndentArray:
+  Enabled: false
+
+# TODO: check again
+Style/IndentHash:
+  Enabled: false
+
+Style/LineEndConcatenation:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+# TODO: check again (force to %r literal)
+Style/RegexpLiteral:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SymbolProc:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/RedundantPercentQ:
+  Enabled: false
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: "map"
+    collect!: "map!"
+    inject: "inject"
+    detect: "find"
+    find_all: "select"
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Security/Open:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 1.16.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at masatonaka1989@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in practice_terraforming.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rspec'
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    practice_terraforming (0.1.3)
+      aws-sdk-iam (~> 1)
+      aws-sdk-s3 (~> 1)
+      multi_json (~> 1.12.1)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    aws-eventstream (1.0.3)
+    aws-partitions (1.237.0)
+    aws-sdk-core (3.76.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.228.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-iam (1.31.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-kms (1.25.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.53.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    jaro_winkler (1.5.4)
+    jmespath (1.4.0)
+    json (2.2.0)
+    multi_json (1.12.2)
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.22.0)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  coveralls (~> 0.8.13)
+  practice_terraforming!
+  rake (~> 10.0)
+  rspec
+  rubocop
+  simplecov (~> 0.14.1)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 masatonaka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,259 @@
+[![CircleCI](https://circleci.com/gh/nakamasato/practice_terraforming.svg?style=svg&circle-token=c3fbff2dec3543a4fce9fd86907f3b6cc9bdfeba)](https://circleci.com/gh/nakamasato/practice_terraforming)
+
+# PracticeTerraforming
+
+This is just for practice!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'practice_terraforming'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install practice_terraforming
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/practice_terraforming. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PracticeTerraforming project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/practice_terraforming/blob/master/CODE_OF_CONDUCT.md).
+
+# How I created this
+
+## Prepare Gem
+
+```
+bundle gem practice_terraforming
+```
+
+## Entrypoint of practice_terraforming
+
+`bin/practice_terraforming`
+
+CLI command (extended Thor)
+
+## lib/practice_terraforming.rb
+
+`lib/practice_terraforming.rb` just requires all the dependencies
+
+## cli definition
+
+`lib/practice_terraforming/cli.rb`
+
+Basically, just copied from `terraforming/lib/terraforming/cli.rb`. Deleted resources but `iam_role` and `s3`
+
+## AWS Resources (Main logic to generate tfstate/tf)
+
+```
+lib/practice_terraforming/resource/iam_role.rb
+lib/practice_terraforming/resource/s3.rb
+```
+
+Resource file is generated by `script/generate` but need to update `tfstate` method
+
+## Util
+
+`lib/practice_terraforming/util.rb`
+
+Just copied from `terraforming/lib/terraforming/util.rb`
+
+## Gemspec
+
+`practice_terraforming.gemspec`
+
+Wrote dependencies with `spec.add_dependency` and `spec.add_development_dependency`
+
+## Templates
+
+- resource.erb.erb -> tf file
+- resource.rb.erb -> resource class to write logic to generate tf file
+- resource_spec.rb.erb -> spec file
+
+## Spec
+
+|spec file|memo|
+|---|---|
+|spec/fixtures/terraform.tfstate|copied from terraforming|
+|spec/lib/practice_terraforming/cli_spec.rb|copied from terraforming|
+|spec/lib/practice_terraforming/resource/<resource>.rb|generated by `script/generate` but need to write by yourself|
+
+
+## Create Resource
+
+0. generate templates with `script/generate`
+
+```
+script/generate iam_policy_attachment
+==> Generate iam_policy_attachment.rb
+==> Generate iam_policy_attachment_spec.rb
+==> Generate iam_policy_attachment.erb
+
+Add below code by hand.
+
+lib/practice_terraforming.rb:
+
+    require "practice_terraforming/resource/iam_policy_attachment"
+
+lib/practice_terraforming/cli.rb:
+
+    module PracticeTerraforming
+      class CLI < Thor
+
+        # Subcommand name should be acronym.
+        desc "iam_policy_attachment", "Iam Policy Attachment"
+        def iam_policy_attachment
+          execute(PracticeTerraforming::Resource::IamPolicyAttachment, options)
+        end
+
+spec/lib/practice_terraforming/cli_spec.rb:
+
+    module PracticeTerraforming
+      describe CLI do
+        context "resources" do
+        describe "iam_policy_attachment" do
+          let(:klass)   { PracticeTerraforming::Resource::IamPolicyAttachment }
+          let(:command) { :iam_policy_attachment }
+
+          it_behaves_like "CLI examples"
+        end
+```
+
+1. As the message says, add those codes.
+2. `lib/practice_terraforming/resource/iam_policy_attachment.rb`: Change Aws client and write logic in `tfstate` method
+
+    Use aws-sdk-<resource> to get the input data and write the logic to generate tf/tfstate file.
+    1. tf -> only need to update the template file, which appears in the next step
+    2. tfstate -> get resource list using private method, format them into resources and return them
+    3. As for private methods:
+      - module_name_of(<resource>) -> used for module name of terraform to be imported
+      - <api method name, e.g. entities_for_policy> -> get the resource info with aws-sdk
+      - other -> make a list of resources to be used in `tfstate` method
+
+3. `lib/practice_terraforming/template/tf/iam_policy_attachment.erb`: Update the erb based on the corresponding terraform resource.
+
+    ```
+    <% iam_policy_attachments.each do |policy_attachment| -%>
+    resource "aws_iam_policy_attachment" "<%= module_name_of(policy_attachment) %>" {
+        name       = "<%= policy_attachment[:name] %>"
+        policy_arn = "<%= policy_attachment[:arn] %>"
+        groups     = <%= policy_attachment[:entities].policy_groups.map(&:group_name).inspect %>
+        users      = <%= policy_attachment[:entities].policy_users.map(&:user_name).inspect %>
+        roles      = <%= policy_attachment[:entities].policy_roles.map(&:role_name).inspect %>
+    }
+
+    <% end -%>
+    ```
+
+4. `spec/lib/practice_terraforming/resource/iam_policy_attachment_spec.rb`: Change Aws client and write test for tf and tfstate
+
+    Test Perspective:
+    1. Create aws sdk result using stub.
+    2. Use the module to generate tf/tfstate.
+    3. Compare expected one and generated one.
+    ```
+    irb(main):007:0> client.list_policies.policies[0]
+    => #<struct Aws::IAM::Types::Policy policy_name="test-policy", policy_id="ABCDEFG", arn="arn:aws:iam::123456789:policy/test-policy", path="/", default_version_id="v1", attachment_count=1, permissions_boundary_usage_count=0, is_attachable=true, description=nil, create_date=2019-01-01 00:00:00 UTC, update_date=2019-01-02 00:00:00 UTC>
+client.list_entities_for_policy(policy_arn: "arn:aws:iam::351540792571:policy/ai-suggest-batch-user-policy")
+    irb(main):008:0> client.list_entities_for_policy(policy_arn: "arn:aws:iam::123456789:policy/test-policy")
+    => #<struct Aws::IAM::Types::ListEntitiesForPolicyResponse policy_groups=[#<struct Aws::IAM::Types::PolicyGroup group_name="test-group", group_id="ABCDEFG">], policy_users=[], policy_roles=[], is_truncated=false, marker=nil>
+    ```
+
+    ```
+    let(:policies) do
+       [
+          {
+            policy_name: "test-policy",
+            policy_id: "ABCDEFG",
+            arn: "arn:aws:iam::123456789:policy/test-policy",
+            path: "/",
+            default_version_id: "v1",
+            attachment_count: 1,
+            is_attachable: true,
+            create_date: Time.parse("2019-01-01 00:00:00 UTC"),
+            update_date: Time.parse("2019-01-02 00:00:00 UTC"),
+            description: nil,
+          }
+        ]
+    end
+
+    let(:entities_for_policy) do
+      {
+        policy_groups: [
+          { group_name: "test-group",  group_id: "ABCDEFG" },
+        ],
+        policy_users: [],
+        policy_roles: [],
+      }
+    end
+
+    before do
+      client.stub_responses(:list_policies, policies: policies)
+      client.stub_responses(:list_entities_for_policy, [entities_for_policy])
+    end
+    ```
+
+## Install on local
+
+### Build
+
+```
+gem build practice_terraforming.gemspec
+```
+
+the above command will generate the `practice_terraforming-X.X.X.gem`
+
+### Install
+
+0.1.0 as an example
+
+```
+gem install practice_terraforming-0.1.0.gem
+Successfully installed practice_terraforming-0.1.0
+Parsing documentation for practice_terraforming-0.1.0
+Installing ri documentation for practice_terraforming-0.1.0
+Done installing documentation for practice_terraforming after 0 seconds
+1 gem installed
+```
+
+### Check
+
+```
+practice_terraforming
+Commands:
+  practice_terraforming help [COMMAND]  # Describe available commands or one specific command
+  practice_terraforming iamr            # Iam Role
+  practice_terraforming s3              # S3
+
+Options:
+  [--merge=MERGE]                                # tfstate file to merge
+  [--overwrite], [--no-overwrite]                # Overwrite existing tfstate
+  [--tfstate], [--no-tfstate]                    # Generate tfstate
+  [--profile=PROFILE]                            # AWS credentials profile
+  [--region=REGION]                              # AWS region
+  [--assume=ASSUME]                              # Role ARN to assume
+  [--use-bundled-cert], [--no-use-bundled-cert]  # Use the bundled CA certificate from AWS SDK
+```