ansible-utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e2e4706605599532f5bd35b3576e4192d9d9c65ebc0575b39f9f5f8ad8843cb
+  data.tar.gz: f350353767ba75a8fd7c2b8de9e39ebe08a5fa478662951891714fbad20c9cf1
+SHA512:
+  metadata.gz: 7b9c279fd741799d5f8270a8ddcfbdd5898174d6da17bcfad43031be1dfb52a05c0f789e20de1d2b7192037ee7868f685c69d3728d631cbddf72ec955dc3eceb
+  data.tar.gz: 2f52f0f7a042a1323c32ffc0fb28d4e9911e4b965513b6babe685bb7729620e741dd451bf98ff729cf621b6180935a4859614dfff28499ac7f8c59aa3e31fc61

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# 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 krzysztof.maicher@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,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pg_export.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    ansible-utils (0.1.0)
+      commander (~> 4.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    coderay (1.1.3)
+    commander (4.5.2)
+      highline (~> 2.0.0)
+    diff-lcs (1.4.4)
+    highline (2.0.3)
+    jaro_winkler (1.5.4)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    powerpack (0.1.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (0.59.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  ansible-utils!
+  bundler (~> 2.1)
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.4)
+  rubocop (~> 0.59.2)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Populate
+
+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,53 @@
+# ansible-utils
+
+Ansible tools for our daily workflows.
+
+`$ ansible-utils --help`:
+
+```
+  NAME:
+
+    Ansible Utils
+
+  DESCRIPTION:
+
+    Utils for managing Ansible projects
+
+  COMMANDS:
+
+    config        Creates and edits the configuration
+    copy_roles    Copy playbook roles from generic source
+    help          Display global or [command] help documentation
+    symlink_roles Symlink playbook roles from generic source
+
+  GLOBAL OPTIONS:
+
+    -h, --help
+        Display help documentation
+
+    -v, --version
+        Display version information
+
+    -t, --trace
+        Display backtrace when an error occurs
+```
+
+## Setup
+
+```
+$ gem install ansible-utils
+```
+
+Once installed run `$ ansible-utils config` to complete the configuration. You'll need to add the path to the generic roles folder.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/PopulateTools/ansible-utils. 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](http://opensource.org/licenses/MIT).
+
+## Authors
+
+This is a project developed by [Populate](https://populate.tools).

data/ansible_utils.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ansible_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "ansible-utils"
+  spec.version = "0.1.0"
+  spec.authors = ['Víctor Martín', 'Fernando Blat']
+  spec.email   = ['victor@populate.tools', 'fernando@populate.tools']
+  spec.summary = "PopulateTools Ansible Utils"
+  spec.homepage = "https://github.com/PopulateTools/ansible-utils"
+  spec.license = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ['ansible-utils']
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.add_dependency "commander", "~> 4.5"
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.59.2'
+end
+

data/bin/ansible-utils

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# dependencies
+require "commander/import"
+
+# standard lib
+require "yaml"
+require "fileutils"
+
+# modules
+require_relative "../lib/ansible_utils/dependency_manager"
+require_relative "../lib/ansible_utils/playbook_helpers"
+require_relative "../lib/ansible_utils/version"
+
+include AnsibleUtils::PlaybookHelpers
+
+program :name, "Ansible Utils"
+program :version, AnsibleUtils::VERSION
+program :description, "Utils for managing Ansible projects"
+
+command :copy_roles do |c|
+  c.syntax = "ansible-utils copy_roles <playbook>"
+  c.description = "Copy playbook roles from generic source"
+  c.option "-f", "--force", "Overwrite existing roles"
+  c.action do |args, options|
+    options.default force: false
+    AnsibleUtils::DependencyManager.new(args.first, options).copy_roles
+  end
+end
+
+command :symlink_roles do |c|
+  c.syntax = "ansible-utils symlink_roles <playbook>"
+  c.description = "Symlink playbook roles from generic source"
+  c.option "-f", "--force", "Overwrite existing roles"
+  c.action do |args, options|
+    options.default force: false
+    AnsibleUtils::DependencyManager.new(args.first, options).symlink_roles
+  end
+end
+
+command :config do |c|
+  c.syntax = "ansible-utils config"
+  c.description = "Check configuration"
+  c.action do |args, _|
+    if !File.file?(config_file_path)
+      puts "[!!] Config file at #{config_file_path} doesn't exist. Creating..."
+      puts "[OK] Created file #{config_file_path}. Open it with your editor"
+      FileUtils.mkdir_p(File.join(ENV.fetch('HOME'), '.config', 'ansible-utils'))
+      File.write(config_file_path, "---\ngeneric_roles_path: ")
+    else
+      puts "[OK] Config file found. Checking syntax and content..."
+      folder = generic_roles_folder
+      if folder
+        puts "[OK] Syntax is fine"
+      else
+        puts "[!!] Syntax seems to be wrong, couldn't read value"
+      end
+      if Dir.exists?(folder)
+        puts "[OK] Generic folder exist: #{folder}"
+      else
+        puts "[!!] Generic folder referenced in the file doesn't exist: #{folder}"
+      end
+    end
+  end
+end
+
+

data/lib/ansible_utils/dependency_manager.rb

@@ -0,0 +1,48 @@
+require_relative "playbook_helpers"
+
+module AnsibleUtils
+  class DependencyManager
+    include PlaybookHelpers
+
+    attr_reader :playbook_path, :options
+
+    def initialize playbook_path, options = {}
+      @playbook_path = playbook_path
+      @options = options
+    end
+
+    def symlink_roles
+      paths.each{|path| execute_in_path(:symlink, path) }
+    end
+
+    def copy_roles
+      paths.each{|path| execute_in_path(:copy, path) }
+    end
+
+    private
+
+    def execute_in_path action, path
+      populate_ansible_path = File.join(generic_roles_folder, path) if generic_roles_folder
+      project_path = File.join(project_folder, path)
+      file_utils_method = action == :copy ? :copy_entry : :ln_s
+
+      if !File.directory?(populate_ansible_path)
+        puts "- Ignoring role '#{path}' because it does not exist in populate-ansible"
+      else
+        dirname = File.dirname(project_path)
+        if Dir.exists?(project_path)
+          if options.force
+            puts "+ Overwritting role '#{path}'"
+            delete_if_exists(project_path)
+          else
+            puts "- Skipping existing role '#{path}' (use --force option to overwrite it)"
+            return
+          end
+        end
+        puts "+ Adding role '#{path}'"
+        FileUtils.mkdir_p(dirname)
+        FileUtils.send(file_utils_method, populate_ansible_path, project_path)
+      end
+    end
+  end
+end

data/lib/ansible_utils/playbook_helpers.rb

@@ -0,0 +1,40 @@
+module AnsibleUtils
+  module PlaybookHelpers
+
+    def config_file_path
+      @config_file_path ||= File.join(ENV.fetch('HOME'), '.config', 'ansible-utils', 'config.yml')
+    end
+
+    def delete_if_exists path
+      FileUtils.remove_entry(path, true)
+    end
+
+    def paths
+      @paths ||= roles.map{|role| role['role'] }
+    end
+
+    def roles
+      playbook['roles']
+    end
+
+    def project_folder
+      @project_folder ||= File.dirname(playbook_path)
+    end
+
+    def generic_roles_folder
+      begin
+        if File.file?(config_file_path)
+          return YAML.load(File.read(config_file_path))['generic_roles_path']
+        else
+          raise "Missing config file at #{config_file_path}. Run `ansible-utils config` for proper setup"
+        end
+      rescue Psych::SyntaxError
+        raise "Error reading config file at #{config_file_path}"
+      end
+    end
+
+    def playbook
+      @playbook ||= YAML.load_file(playbook_path).first
+    end
+  end
+end

data/lib/ansible_utils/version.rb

@@ -0,0 +1,3 @@
+module AnsibleUtils
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: ansible-utils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Víctor Martín
+- Fernando Blat
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+description:
+email:
+- victor@populate.tools
+- fernando@populate.tools
+executables:
+- ansible-utils
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- ansible_utils.gemspec
+- bin/ansible-utils
+- lib/ansible_utils/dependency_manager.rb
+- lib/ansible_utils/playbook_helpers.rb
+- lib/ansible_utils/version.rb
+homepage: https://github.com/PopulateTools/ansible-utils
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: PopulateTools Ansible Utils
+test_files: []