quixoten-puppetdb-terminus 2.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93b5e73c9a812b65d7a4c748ffe8e7630c8e5539
+  data.tar.gz: 8e15bc1afe25ae2b18a187c1d3aac23b43550df5
+SHA512:
+  metadata.gz: b7586a4405e67cba5ec10e03f929fcf3594bb34720302c99e06b13c7890cbf82a4f4b8930833b70675e0a3397ca6a22b038716b2f7fb7e1d3bde82c7ab7495bd
+  data.tar.gz: 32222466369bfc4608c82f17edea290ea4c15c26bc1386f8006476b530ba9c6deabdf77fc6e3aa081c0b2414804f1892a30f31d20bc056c93674d87a8715d9b2

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.tar.gz

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puppetdb-terminus.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 MoneyDesktop, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,29 @@
+# PuppetDB Terminus
+
+PuppetDB Terminus packaged as a gem
+
+The version of PuppetDB used to build the gem is reflected in the gems version,
+e.g., version 2.0.0.3 of PuppetDB Terminus is the third build against the
+source from PuppetDB 2.0.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'quixoten-puppetdb-terminus'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quixoten-puppetdb-terminus
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/puppetdb-terminus/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "fileutils"
+require "puppetdb-terminus"
+
+desc "Download source from PuppetDB #{PuppetDB::Terminus::VERSION}"
+task :download_source do
+  version = ::PuppetDB::Terminus::VERSION.sub(/\.[^.]+$/, '')
+  archive = "#{version}.tar.gz"
+  url     = "https://github.com/puppetlabs/puppetdb/archive/#{archive}"
+
+  `curl -sLO #{url}`
+  FileUtils::rm_rf File.expand_path('../lib/puppet', __FILE__)
+  `tar axf #{archive} puppetdb-#{version}/puppet/lib/ --strip-components=2`
+end
+
+task :build => :download_source

data/lib/puppet/application/storeconfigs.rb

@@ -0,0 +1,4 @@
+require 'puppet/application/face_base'
+
+class Puppet::Application::Storeconfigs < Puppet::Application::FaceBase
+end

data/lib/puppet/face/node/deactivate.rb

@@ -0,0 +1,38 @@
+require 'puppet/util/puppetdb'
+require 'puppet/util/puppetdb/command_names'
+
+Puppet::Face.define(:node, '0.0.1') do
+
+  CommandDeactivateNode = Puppet::Util::Puppetdb::CommandNames::CommandDeactivateNode
+
+  action :deactivate do
+    summary "Deactivate a set of nodes in PuppetDB"
+    arguments "<node> [<node> ...]"
+    description <<-DESC
+      This will issue '#{CommandDeactivateNode}' commands to the PuppetDB server for
+      each node specified. The server is found by looking in
+      $confdir/puppetdb.conf. If any command submissions fail, the process will
+    be aborted.
+    DESC
+
+    when_invoked do |*args|
+      Puppet::Util::Puppetdb::GlobalCheck.run
+
+      opts = args.pop
+      raise ArgumentError, "Please provide at least one node for deactivation" if args.empty?
+
+      Puppet::Node.indirection.terminus_class = :puppetdb
+      Puppet::Node.indirection.cache_class = nil
+
+      args.inject({}) do |results,node|
+        results.merge node => Puppet::Node.indirection.destroy(node)['uuid']
+      end
+    end
+
+    when_rendering(:console) do |value|
+      value.map do |node,uuid|
+        "Submitted '#{CommandDeactivateNode}' for #{node} with UUID #{uuid}"
+      end.join("\n")
+    end
+  end
+end

data/lib/puppet/face/node/status.rb

@@ -0,0 +1,83 @@
+Puppet::Face.define(:node, '0.0.1') do
+  action :status do
+    summary "Fetch the current status for a set of nodes in PuppetDB"
+    arguments "<node> [<node> ...]"
+    description <<-DESC
+      This action will retrieve the current status of a set of nodes from
+      PuppetDB. The information provided includes whether the node is active,
+      and the timestamps of its last catalog and facts. The PuppetDB server is
+      found by looking in $confdir/puppetdb.conf.
+    DESC
+
+    when_invoked do |*args|
+      require 'puppet/network/http_pool'
+      require 'puppet/util/puppetdb'
+      require 'json'
+
+      Puppet::Util::Puppetdb::GlobalCheck.run
+
+      opts = args.pop
+      raise ArgumentError, "Please provide at least one node" if args.empty?
+
+      server = Puppet::Util::Puppetdb.server
+      port = Puppet::Util::Puppetdb.port
+
+      http = Puppet::Network::HttpPool.http_instance(server, port)
+
+      args.map do |node|
+        begin
+          response = http.get("/v3/nodes/#{CGI.escape(node)}", headers)
+          if response.is_a? Net::HTTPSuccess
+            result = JSON.parse(response.body)
+          elsif response.is_a? Net::HTTPNotFound
+            result = {'name' => node}
+          else
+            raise "[#{response.code} #{response.message}] #{response.body.gsub(/[\r\n]/, '')}"
+          end
+        rescue => e
+          Puppet.err "Could not retrieve status for #{node}: #{e}"
+        end
+        result
+      end.compact
+    end
+
+    when_rendering(:console) do |value|
+      value.map do |status|
+        lines = [status['name']]
+
+        # If all we have is the name, then we made this hash because of a 404
+        if status.keys == ['name']
+          lines << "No information known"
+          next lines.join("\n")
+        end
+
+        if status['deactivated']
+          lines << "Deactivated at #{status['deactivated']}"
+        else
+          lines << "Currently active"
+        end
+
+        if status['catalog_timestamp']
+          lines << "Last catalog: #{status['catalog_timestamp']}"
+        else
+          lines << "No catalog received"
+        end
+
+        if status['facts_timestamp']
+          lines << "Last facts: #{status['facts_timestamp']}"
+        else
+          lines << "No facts received"
+        end
+
+        lines.join("\n")
+      end.join("\n\n")
+    end
+  end
+
+  def headers
+    {
+      "Accept" => "application/json",
+      "Content-Type" => "application/x-www-form-urlencoded; charset=UTF-8",
+    }
+  end
+end

data/lib/puppet/face/storeconfigs.rb

@@ -0,0 +1,179 @@
+require 'puppet/face'
+require 'tmpdir'
+
+Puppet::Face.define(:storeconfigs, '0.0.1') do
+  copyright "Puppet Labs", 2011
+  license   "Apache 2 license"
+
+  summary "Interact with the storeconfigs database"
+  description <<-DESC
+    This subcommand interacts with the ActiveRecord storeconfigs database, and
+    can be used to export a dump of that data which is suitable for import by
+    PuppetDB.
+  DESC
+
+  action :export do
+    summary "Export the storeconfigs database"
+    description <<-DESC
+      Generate a dump of all catalogs from the storeconfigs database, as a
+      tarball which can be imported by PuppetDB. Only exported resources are
+      included; non-exported resources, edges, facts, or other data are
+      omitted. Returns the location of the output.
+    DESC
+
+    when_invoked do |options|
+      require 'puppet/util/puppetdb/global_check'
+      Puppet::Util::Puppetdb::GlobalCheck.run
+
+      require 'puppet/rails'
+
+      tmpdir = Dir.mktmpdir
+      workdir = File.join(tmpdir, 'puppetdb-bak')
+      Dir.mkdir(workdir)
+
+      begin
+        Puppet::Rails.connect
+
+        # Fetch all nodes, including exported resources and their params
+        nodes = Puppet::Rails::Host.all(:include => {:resources => [:param_values, :puppet_tags]},
+                                        :conditions => {:resources => {:exported => true}})
+
+        catalogs = nodes.map { |node| node_to_catalog_hash(node) }
+
+        catalog_dir = File.join(workdir, 'catalogs')
+        FileUtils.mkdir(catalog_dir)
+
+        catalogs.each do |catalog|
+          filename = File.join(catalog_dir, "#{catalog[:data][:name]}.json")
+
+          File.open(filename, 'w') do |file|
+            file.puts catalog.to_pson
+          end
+        end
+
+        node_names = nodes.map(&:name).sort
+
+        timestamp = Time.now
+
+        File.open(File.join(workdir, 'export-metadata.json'), 'w') do |file|
+          metadata = {
+            'timestamp' => timestamp,
+            'command-versions' => {
+              'replace-catalog' => 2,
+            }
+          }
+
+          file.puts metadata.to_pson
+        end
+
+        tarfile = destination_file(timestamp)
+
+        if tar = Puppet::Util.which('tar')
+          execute("cd #{tmpdir} && #{tar} -cf #{tarfile} puppetdb-bak")
+
+          FileUtils.rm_rf(workdir)
+
+          if gzip = Puppet::Util.which('gzip')
+            execute("#{gzip} #{tarfile}")
+            "#{tarfile}.gz"
+          else
+            Puppet.warning "Can't find the `gzip` command to compress the tarball; output will not be compressed"
+            tarfile
+          end
+        else
+          Puppet.warning "Can't find the `tar` command to produce a tarball; output will remain in the temporary working directory"
+          workdir
+        end
+      rescue => e
+        # Clean up if something goes wrong. We don't want to ensure this,
+        # because we want the directory to stick around in the case where they
+        # don't have tar.
+        FileUtils.rm_rf(workdir)
+        raise
+      end
+    end
+
+    when_rendering :console do |filename|
+      "Exported storeconfigs data to #{filename}"
+    end
+  end
+
+  # Returns the location to leave the output. This is really only here for testing. :/
+  def destination_file(timestamp)
+    File.expand_path("storeconfigs-#{timestamp.strftime('%Y%m%d%H%M%S')}.tar")
+  end
+
+  # Execute a command using Puppet's execution static method.
+  #
+  # @param command [Array<String>, String] the command to execute. If it is
+  #   an Array the first element should be the executable and the rest of the
+  #   elements should be the individual arguments to that executable.
+  # @return [Puppet::Util::Execution::ProcessOutput] output as specified by options
+  # @raise [Puppet::ExecutionFailure] if the executed chiled process did not exit with status == 0 and `failonfail` is
+  #   `true`.
+  def execute(command)
+    Puppet::Util::Execution.execute(command)
+  end
+
+  def node_to_catalog_hash(node)
+    resources = node.resources.map { |resource| resource_to_hash(resource) }
+    edges = node.resources.map { |resource| resource_to_edge_hash(resource) }
+
+    {
+      :metadata => {
+        :api_version => 1,
+      },
+      :data => {
+        :name => node.name,
+        :version => node.last_compile || Time.now,
+        :edges => edges,
+        :resources => resources + [stage_main_hash],
+      },
+    }
+  end
+
+  def resource_to_hash(resource)
+    parameters = resource.param_values.inject({}) do |params,param_value|
+      if params.has_key?(param_value.param_name.name)
+        value = [params[param_value.param_name.name],param_value.value].flatten
+      else
+        value = param_value.value
+      end
+      params.merge(param_value.param_name.name => value)
+    end
+
+    tags = resource.puppet_tags.map(&:name).uniq.sort
+
+    hash = {
+      :type       => resource.restype,
+      :title      => resource.title,
+      :exported   => true,
+      :parameters => parameters,
+      :tags       => tags,
+    }
+
+    hash[:file] = resource.file if resource.file
+    hash[:line] = resource.line if resource.line
+
+    hash
+  end
+
+  # The catalog *must* have edges, so everything is contained by Stage[main]!
+  def resource_to_edge_hash(resource)
+    {
+      'source' => {'type' => 'Stage', 'title' => 'main'},
+      'target' => {'type' => resource.restype, 'title' => resource.title},
+      'relationship' => 'contains',
+    }
+  end
+
+  def stage_main_hash
+    {
+      :type       => 'Stage',
+      :title      => 'main',
+      :exported   => false,
+      :parameters => {},
+      :tags       => ['stage', 'main'],
+    }
+  end
+end