stax-lint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b95546ccfee9fabdd4de2be0e1817b168f5f65067ad366d7f2d3529295c1f7a
+  data.tar.gz: 6374124cf6d9dc3f91dd7a1951e41e695333ba7bf5f691fbba2c9526dd7b085d
+SHA512:
+  metadata.gz: 2c925d2712922684fe735f0a75115091fe7575564e88084f0fceeb19e60a982f394fa3a321e4898e63acc2242181c09f3a09f5cef5ac4c029a7b93bfe0db4528
+  data.tar.gz: 5de07bd6f6358aefdc55c30c230e5a14ee6645ba354532a9dfb17b7d0c69b358d428ab6567a05f98391378603d8e343dd981c5bfcb79059fe4959e8dac664d75

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 rlister@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,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stax-lint.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Richard Lister
+
+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,41 @@
+# stax-lint
+
+Cloudformation stack linting tasks for [stax](https://github.com/rlister/stax).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add stax-lint
+
+Require in `Staxfile`:
+
+    require 'stax/lint'
+
+## Linters
+
+### cfn-lint
+
+Install `cfn-lint` from https://github.com/aws-cloudformation/cfn-python-lint, and run for any stack `foo`:
+
+    $ bundle exec stax foo lint
+
+Run for all stacks in `Staxfile`:
+
+    $ bundle exec stax lint
+
+### checkov
+
+Install `checkov` from https://www.checkov.io/, and run for any stack `foo`:
+
+    $ bundle exec stax foo checkov
+
+Run for all stacks in `Staxfile`:
+
+    $ bundle exec stax checkov
+
+Ref: [checkov reference](https://www.checkov.io/2.Basics/CLI%20Command%20Reference.html).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: :spec

data/lib/stax/lint/cfn-lint.rb

@@ -0,0 +1,25 @@
+module Stax
+  class Stack
+    desc 'lint', 'run cfn-lint on template'
+    def lint
+      require 'open3'
+      debug("cfn-lint #{stack_name}")
+      Open3.popen3('cfn-lint -') do |stdin, stdout|
+        stdin.write(cfn_template)
+        stdin.close
+        puts stdout.read
+      end
+    rescue Errno::ENOENT => e
+      fail_task(e.message)
+    end
+  end
+end
+
+module Stax
+  class Cli
+    desc 'lint', 'run cfn-lint on all templates'
+    def lint
+      stack_objects.each(&:lint)
+    end
+  end
+end

data/lib/stax/lint/checkov.rb

@@ -0,0 +1,23 @@
+module Stax
+  class Stack
+    desc 'checkov', 'run cfn-checkov on template'
+    def checkov
+      debug("checkov #{stack_name}")
+      file = Tempfile.create(["#{stack_name}-", '.json'])
+      file.write(cfn_template)
+      file.flush
+      Dir.chdir(File.dirname(file.path)) do
+        system "checkov --quiet --compact --framework cloudformation -f #{File.basename(file.path)}"
+      end
+    end
+  end
+end
+
+module Stax
+  class Cli
+    desc 'checkov', 'run checkov on all templates'
+    def checkov
+      stack_objects.each(&:checkov)
+    end
+  end
+end

data/lib/stax/lint/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Stax
+  module Lint
+    VERSION = "0.1.0"
+  end
+end

data/lib/stax/lint.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'lint/version'
+require_relative 'lint/cfn-lint'
+require_relative 'lint/checkov'

data/stax-lint.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/stax/lint/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'stax-lint'
+  spec.version = Stax::Lint::VERSION
+  spec.authors = ['Richard Lister']
+  spec.email = ['rlister@gmail.com']
+
+  spec.summary = 'Add support for various linting tools to stax.'
+  spec.description = 'Stax is a flexible set of ruby classes for cloudformation stacks: stax-lint adds support for linting tools.'
+  spec.homepage = 'https://github.com/rlister/stax-lint'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/rlister/stax-lint'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+
+  spec.bindir = 'bin'
+  spec.executables = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('stax')
+  spec.add_dependency('open3')
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: stax-lint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Lister
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stax
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: open3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Stax is a flexible set of ruby classes for cloudformation stacks: stax-lint
+  adds support for linting tools.'
+email:
+- rlister@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stax/lint.rb
+- lib/stax/lint/cfn-lint.rb
+- lib/stax/lint/checkov.rb
+- lib/stax/lint/version.rb
+- stax-lint.gemspec
+homepage: https://github.com/rlister/stax-lint
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rlister/stax-lint
+  source_code_uri: https://github.com/rlister/stax-lint
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Add support for various linting tools to stax.
+test_files: []