sensu-translator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ae7fd5222ecd1a4386de4bda4742cd2d4dc439f
+  data.tar.gz: efdadf8ef3c87af010c70c340b7ca66850e27fd3
+SHA512:
+  metadata.gz: 781e2f2cf93423f8b9173c28215644370ddae8d663d5f6d3825ad72403f286e80776fae2e9d053c98be74a836ff076ba883e551fbafd443b606ab03e48b67356
+  data.tar.gz: 30e7636d494197da11f1ce7a1c2bf696a04338e9ea69e54b03f1bac6432b6b72e7aaad89b368be1e0fbf7b1d9f22c437d9de8607bd109653b189975f3f738849

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [0.1.0] - 2018-03-26
+### Added
+- Inital release (still experimental)
+
+### Changed
+
+### Fixed
+
+### Breaking Change

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sensu-translator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Sensu
+
+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,68 @@
+[![Build Status](https://img.shields.io/travis/sensu/sensu-translator.svg)](https://travis-ci.org/sensu/sensu-translator)
+[![Gem Version](https://img.shields.io/gem/v/sensu-translator.svg)](https://github.com/sensu/sensu-translator/blob/master/CHANGELOG.md)
+[![MIT Licensed](https://img.shields.io/github/license/sensu/sensu-translator.svg)](https://raw.githubusercontent.com/sensu/sensu-translator/master/LICENSE)
+[![Join the chat at https://slack.sensu.io/](https://slack.sensu.io/badge.svg)](https://slack.sensu.io/)
+
+# Sensu Translator
+
+A CLI tool for translating Sensu 1.x configuration into the Sensu 2.x format.
+
+## Installation
+
+`gem install sensu-translator`
+
+## Usage
+
+```
+Usage: sensu-translator [options]
+    -h, --help                       Display this message
+    -V, --version                    Display version
+    -c, --config FILE                Sensu 1.x JSON config FILE. Default: /etc/sensu/config.json (if exists)
+    -d, --config_dir DIR[,DIR]       DIR or comma-delimited DIR list for Sensu 1.x JSON config files. Default: /etc/sensu/conf.d (if exists)
+    -o, --output_dir DIR             Sensu 2.0 config output DIR. Default: /tmp/sensu_v2
+    -O, --organization ORG           Sensu 2.0 RBAC Organization. Default: default
+    -E, --environment ENV            Sensu 2.0 RBAC Environment. Default: default
+```
+
+## Example
+
+1. Translate Sensu 1.x configuration into the Sensu 2.x format
+
+```
+$ sensu-translator -c /etc/sensu/config.json -d /etc/sensu/conf.d -o /tmp/sensu_v2
+
+$ tree /tmp/sensu_v2
+
+/tmp/sensu_v2
+├── checks
+│   ├── website-healthz.json
+│   └── haproxy-backends.json
+├── extensions
+├── filters
+├── handlers
+│   ├── email.json
+│   └── default.json
+└── mutators
+    ├── obfuscate.json
+    └── tag.json
+```
+
+2. Use a configured `sensuctl` and the newly created 2.x configuration files to manage Sensu 2.x resources
+
+```
+sensuctl create -f /tmp/sensu_v2/checks/website-healthz.json
+```
+
+## 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/sensu/sensu-translator.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sensu/translator"
+
+# 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/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/exe/sensu-translator

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "sensu/translator"
+
+translator = Sensu::Translator::Runner.new
+translator.run

data/lib/sensu/translator/cli.rb

@@ -0,0 +1,55 @@
+require "optparse"
+
+module Sensu
+  module Translator
+    class CLI
+      # Parse CLI arguments using Ruby stdlib `optparse`. This method
+      # provides Sensu Translator with process options (eg. config
+      # directory), and can provide users with information, such as the
+      # Translator version.
+      #
+      # @param arguments [Array] to parse.
+      # @return [Hash] options
+      def self.read(arguments=ARGV)
+        options = {
+          :output_dir => "/tmp/sensu_v2",
+          :organization => "default",
+          :environment => "default"
+        }
+        if File.exist?("/etc/sensu/config.json")
+          options[:config_file] = "/etc/sensu/config.json"
+        end
+        if Dir.exist?("/etc/sensu/conf.d")
+          options[:config_dirs] = ["/etc/sensu/conf.d"]
+        end
+        optparse = OptionParser.new do |opts|
+          opts.on("-h", "--help", "Display this message") do
+            puts opts
+            exit
+          end
+          opts.on("-V", "--version", "Display version") do
+            puts Sensu::Translator::VERSION
+            exit
+          end
+          opts.on("-c", "--config FILE", "Sensu 1.x JSON config FILE. Default: /etc/sensu/config.json (if exists)") do |file|
+            options[:config_file] = file
+          end
+          opts.on("-d", "--config_dir DIR[,DIR]", "DIR or comma-delimited DIR list for Sensu 1.x JSON config files. Default: /etc/sensu/conf.d (if exists)") do |dir|
+            options[:config_dirs] = dir.split(",")
+          end
+          opts.on("-o", "--output_dir DIR", "Sensu 2.0 config output DIR. Default: /tmp/sensu_v2") do |dir|
+            options[:output_dir] = dir
+          end
+          opts.on("-O", "--organization ORG", "Sensu 2.0 RBAC Organization. Default: default") do |org|
+            options[:organization] = org
+          end
+          opts.on("-E", "--environment ENV", "Sensu 2.0 RBAC Environment. Default: default") do |env|
+            options[:environment] = env
+          end
+        end
+        optparse.parse!(arguments)
+        options
+      end
+    end
+  end
+end

data/lib/sensu/translator/translations.rb

@@ -0,0 +1,46 @@
+module Sensu
+  module Translator
+    module Translations
+      def v2_spec(type, object, organization, environment)
+        {
+          :type => type.to_s.capitalize,
+          :spec => object.merge(:organization => organization, :environment => environment)
+        }
+      end
+
+      def translate_check(check, organization, environment)
+        check[:subscriptions] = check.delete(:subscribers) || []
+        if check[:standalone]
+          check.delete(:standalone)
+          check[:subscriptions] << "standalone"
+        end
+        check[:publish] = check.fetch(:publish, true)
+        check[:handlers] ||= [check.fetch(:handler, "default")]
+        if check[:source]
+          check[:proxy_entity_id] = check.delete(:source)
+        end
+        v2_spec(:check, check, organization, environment)
+      end
+
+      def translate_filter(filter, organization, environment)
+        puts "Sensu 1.x filter translation is not yet supported"
+        puts "Unable to translate Sensu 1.x filter: #{filter}"
+        nil
+      end
+
+      def translate_mutator(mutator, organization, environment)
+        v2_spec(:mutator, mutator, organization, environment)
+      end
+
+      def translate_handler(handler, organization, environment)
+        v2_spec(:handler, handler, organization, environment)
+      end
+
+      def translate_extension(extension, organization, environment)
+        puts "Sensu 1.x extension translation is not yet supported"
+        puts "Unable to translate Sensu 1.x extension: #{extension}"
+        nil
+      end
+    end
+  end
+end

data/lib/sensu/translator/version.rb

@@ -0,0 +1,5 @@
+module Sensu
+  module Translator
+    VERSION = "0.1.0"
+  end
+end

data/lib/sensu/translator.rb

@@ -0,0 +1,69 @@
+gem "sensu-json", "2.1.1"
+gem "sensu-settings", "10.13.1"
+
+require "sensu/translator/cli"
+require "sensu/translator/translations"
+require "sensu/translator/version"
+
+require "sensu/json"
+require "sensu/settings"
+
+require "fileutils"
+
+module Sensu
+  module Translator
+    class Runner
+      include Translations
+
+      def initialize
+        @options = CLI.read
+      end
+
+      def load_v1_settings
+        settings = Sensu::Settings.load(@options)
+        unless settings.errors.empty?
+          puts "Sensu 1.x configuration is invalid!"
+          puts Sensu::JSON.dump({:errors => settings.errors}, :pretty => true)
+          exit 2
+        end
+        settings.to_hash
+      end
+
+      def translate(v1_settings)
+        v2_resources = []
+        Sensu::Settings::CATEGORIES.each do |category|
+          method_name = "translate_#{category.to_s.chop}"
+          v1_settings[category].each do |name, settings|
+            object = {:name => name.to_s}.merge(settings)
+            v2_resources << send(method_name, object, @options[:organization], @options[:environment])
+          end
+        end
+        v2_resources.compact
+      end
+
+      def create_v2_output_files!(v2_resources)
+        output_dir = @options[:output_dir]
+        Sensu::Settings::CATEGORIES.each do |category|
+          category_dir = File.join(output_dir, category.to_s)
+          FileUtils.mkdir_p(category_dir)
+        end
+        v2_resources.each do |v2_resource|
+          category = "#{v2_resource[:type].downcase}s"
+          file_name = "#{v2_resource[:spec][:name]}.json"
+          output_file = File.join(output_dir, category, file_name)
+          content = Sensu::JSON.dump(v2_resource, :pretty => true)
+          File.open(output_file, "w") do |file|
+            file.write(content)
+          end
+        end
+      end
+
+      def run
+        v1_settings = load_v1_settings
+        v2_resources = translate(v1_settings)
+        create_v2_output_files!(v2_resources)
+        puts "DONE!"
+      end
+    end
+  end
+end

data/sensu-translator.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sensu/translator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sensu-translator"
+  spec.version       = Sensu::Translator::VERSION
+  spec.authors       = ["Sean Porter", "Justin Kolberg"]
+  spec.email         = ["portertech@gmail.com", "amd.prophet@gmail.com"]
+
+  spec.summary       = %q{A tool for translating Sensu 1.x config to the Sensu 2.x format.}
+  spec.description   = %q{A tool for translating Sensu 1.x config to the Sensu 2.x format.}
+  spec.homepage      = "https://github.com/sensu/sensu-translator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sensu-json", "2.1.1"
+  spec.add_dependency "sensu-settings", "10.13.1"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: sensu-translator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Porter
+- Justin Kolberg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: sensu-settings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.13.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A tool for translating Sensu 1.x config to the Sensu 2.x format.
+email:
+- portertech@gmail.com
+- amd.prophet@gmail.com
+executables:
+- sensu-translator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/sensu-translator
+- lib/sensu/translator.rb
+- lib/sensu/translator/cli.rb
+- lib/sensu/translator/translations.rb
+- lib/sensu/translator/version.rb
+- sensu-translator.gemspec
+homepage: https://github.com/sensu/sensu-translator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A tool for translating Sensu 1.x config to the Sensu 2.x format.
+test_files: []