foreman_envsync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43ba5621c980daec52589e93abf35284dae0b74b6702f17f119150d11eeb8213
+  data.tar.gz: a7c2fbe23fda6490e1c672bd25a4c29ff65cfc73025a0316178c710b153fda71
+SHA512:
+  metadata.gz: 5eb9986dd85245db0d9887494455e2092f41581659d8db6ea0d78db3a4f1057aa8c0fb2971882e7450a7ee16ca2099ca58002038ad9a0d3f15479996364cc52d
+  data.tar.gz: 595fbeb07c6df54ef4153a406c2279b3775582ca0f6ad4646503e99f622fb0be5256f45378644ad5af14452d4e461199e0cd3778494bb047d843b5a6f2b1f72c

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-06-04
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in foreman_envsync.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Joshua Hoblitt
+
+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,39 @@
+# ForemanEnvsync
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/foreman_envsync`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'foreman_envsync'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install foreman_envsync
+
+## 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 the created tag, 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]/foreman_envsync.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "foreman_envsync"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/foreman_envsync

@@ -0,0 +1,170 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "json"
+require "open3"
+require "optparse"
+require "rest-client"
+require "socket"
+require "yaml"
+
+@options = {}
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: foreman_envsync [options]"
+  opts.separator ""
+  opts.separator "Specifc options:"
+
+  opts.on("-v", "--verbose", "Enable verbose output") do |o|
+    @options[:verbose] = [o]
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+option_parser.parse!
+
+def verbose_list(msg, items)
+  return unless @options[:verbose] && !items.nil?
+
+  printf(msg, items.count)
+  puts
+  puts "#{YAML.dump(items)}\n" unless items.empty?
+end
+
+def cert_file(file)
+  OpenSSL::X509::Certificate.new(File.read(file))
+end
+
+def key_file(file)
+  OpenSSL::PKey::RSA.new(File.read(file))
+end
+
+def hammer_cmd(cmd)
+  stdout, stderr, s = Open3.capture3(cmd)
+  unless s.success?
+    puts "command #{cmd} failed"
+    puts stderr
+    exit s.exitstatus
+  end
+
+  stdout
+end
+
+def hammer_cmd_parse(cmd)
+  stdout = hammer_cmd(cmd)
+
+  JSON.parse(stdout)
+end
+
+def collect_one_field(data, field)
+  # hammer output format is an array of hashes -- one hash per item
+  # convert it to a flat array
+  data.collect { |x| x[field] }
+end
+
+def hammer_cmd_parse_one(cmd, field)
+  collect_one_field(hammer_cmd_parse(cmd), field)
+end
+
+def foreman_env_list
+  field = "Name"
+  cmd = "hammer --output=json puppet-environment list --fields #{field}"
+
+  hammer_cmd_parse_one(cmd, field)
+end
+
+def foreman_env_delete(name)
+  cmd = "hammer --output=json puppet-environment delete --name #{name}"
+
+  hammer_cmd_parse(cmd)
+end
+
+def foreman_env_create(name, location_ids, org_ids)
+  cmd = "hammer --output=json puppet-environment create --name #{name}"
+  cmd += " --location-ids #{location_ids.join(",")}"
+  cmd += " --organization-ids #{org_ids.join(",")}"
+
+  hammer_cmd_parse(cmd)
+end
+
+def foreman_location_ids
+  field = "Id"
+  cmd = "hammer --output=json location list --fields #{field}"
+
+  hammer_cmd_parse_one(cmd, field)
+end
+
+def foreman_org_ids
+  field = "Id"
+  cmd = "hammer --output=json organization list --fields #{field}"
+
+  hammer_cmd_parse_one(cmd, field)
+end
+
+def puppetserver_env_list
+  hostname = Socket.gethostname
+
+  res = RestClient::Request.execute(
+    method: :get,
+    url: "https://#{hostname}:8140/puppet/v3/environments",
+    ssl_client_cert: cert_file("/etc/puppetlabs/puppet/ssl/certs/#{hostname}.pem"),
+    ssl_client_key: key_file("/etc/puppetlabs/puppet/ssl/private_keys/#{hostname}.pem"),
+    verify_ssl: true,
+    ssl_ca_file: "/etc/puppetlabs/puppet/ssl/ca/ca_crt.pem"
+  )
+
+  JSON.parse(res)["environments"].keys
+end
+
+#
+# Fetch list of puppet environments from puppetserver API.
+#
+ps_envs = puppetserver_env_list
+verbose_list "found %d puppetserver environment(s).", ps_envs
+
+#
+# Fetch list of puppet environments from foreman. The hammer cli is used to
+# avoid having to manage credentials.  In theory, foreman supports auth using
+# x509 similar to puppetserver but this failed when tested using both `curl` and
+# configuring hammer to use x509.
+#
+f_envs = foreman_env_list
+verbose_list "found %d foreman environment(s).", f_envs
+
+#
+# Does foreman have any puppet envs puppetserver is unaware of?
+#
+extra_envs = f_envs - ps_envs
+verbose_list "found %d foreman environment(s) unknown to puppetserver.", extra_envs
+
+#
+# Remove any foreman envs unknown to puppetserver
+#
+report = extra_envs.collect { |x| foreman_env_delete(x) } unless extra_envs.empty?
+verbose_list "deleted %d foreman environment(s).", report
+
+# update foreman envs if anything was deleted
+f_envs = foreman_env_list unless report.nil?
+
+#
+# Does puppetserver have any envs foreman is unaware of?
+#
+new_envs = ps_envs - f_envs
+verbose_list "found %d puppetserver environment(s) unknown to foreman.", new_envs
+
+# if not, exit
+exit 0 if new_envs.empty?
+
+#
+# Create new foreman env(s) with all existing locations and organizations
+#
+location_ids = foreman_location_ids
+verbose_list "found %d foreman location(s).", location_ids
+
+org_ids = foreman_org_ids
+verbose_list "found %d foreman organization(s).", org_ids
+
+report = new_envs.collect { |x| foreman_env_create(x, location_ids, org_ids) }
+verbose_list "created %d foreman environment(s).", report

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/foreman_envsync.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/foreman_envsync/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "foreman_envsync"
+  spec.version       = ForemanEnvsync::VERSION
+  spec.authors       = ["Joshua Hoblitt"]
+  spec.email         = ["josh@hoblitt.com"]
+
+  spec.summary       = "Sync pupperserver envs with foreman"
+  spec.homepage      = "https://github.com/lsst-it/foreman_envsync"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/lsst-it/foreman_envsync"
+  spec.metadata["changelog_uri"] = "https://github.com/lsst-it/foreman_envsync/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "hammer_cli"
+  spec.add_dependency "hammer_cli_foreman"
+  spec.add_dependency "rest-client", "~> 2.1.0"
+  spec.add_dependency "rubocop-rake"
+  spec.add_dependency "rubocop-rspec"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/foreman_envsync.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "foreman_envsync/version"
+
+module ForemanEnvsync
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/foreman_envsync/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ForemanEnvsync
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: foreman_envsync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua Hoblitt
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hammer_cli
+  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: hammer_cli_foreman
+  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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  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: rubocop-rspec
+  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:
+email:
+- josh@hoblitt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/foreman_envsync
+- bin/setup
+- foreman_envsync.gemspec
+- lib/foreman_envsync.rb
+- lib/foreman_envsync/version.rb
+homepage: https://github.com/lsst-it/foreman_envsync
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lsst-it/foreman_envsync
+  source_code_uri: https://github.com/lsst-it/foreman_envsync
+  changelog_uri: https://github.com/lsst-it/foreman_envsync/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Sync pupperserver envs with foreman
+test_files: []