puppetdb_cli 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42d242aeb659eede85c99de3e9eb3aba62601f6b
+  data.tar.gz: a9c1b2185eacbe0303cb24344ddf708090c8b475
+SHA512:
+  metadata.gz: ad17edfa9dea21e21ae34998da28f30b4ef5dc6bcda62fca751b3273191015d1280083e9a4508f25bc7a556a319bc60862d58c08c90e291b6f948cf6330a8fe3
+  data.tar.gz: 3608ab3405b2ad0fdf15d0ee5d25f873b5b08b1588d95575d73f51b86519da9831f37639adc4c2d9f94959407e661259e5b4ea158d4ea25a35a519e570ba6811

data/.gitignore

@@ -0,0 +1,27 @@
+# Misc files
+*.swp
+.DS_Store
+Gemfile.local
+Gemfile.lock
+
+# Beaker
+acceptance/.bundle/
+acceptance/vendor/
+acceptance/junit/
+acceptance/log/
+acceptance/hosts.cfg
+acceptance/tmp/
+
+# Ruby
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  Include:
+    - lib/**/*.rb
+    - spec/**/*.rb
+    - acceptance/foss/**/*.rb
+    - exe/**/*.rb
+  Exclude:
+    - vendor/**/*
+    - acceptance/vendor/**/*
+  TargetRubyVersion: 2.3
+Style/ClassAndModuleChildren:
+  Exclude:
+    - lib/**/*
+    - spec/**/*
+    - acceptance/**/*
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - puppetdb_cli.gemspec
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,25 @@
+language: ruby
+sudo: false
+
+script:
+  'bundle exec $CHECK'
+
+notifications:
+  email: false
+
+before_install:
+  - bundle -v
+  - rm Gemfile.lock || true
+  - gem update --system
+  - gem update bundler
+  - gem --version
+  - bundle -v
+
+matrix:
+  include:
+    - rvm: 2.3.1
+      env: CHECK=rspec
+    - rvm: 2.3.1
+      env: CHECK=rubocop
+    - rvm: 2.5.5
+      env: CHECK=rspec

data/CHANGELOG.md

@@ -0,0 +1,54 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [1.1.0] - 2016-07-20
+
+### Features
+
+- New `puppet-db status` subcommand for retreiving the Trapperkeeper statuses of
+  your PuppetDB instances.
+  
+### Fixed
+
+- OpenSSL is properly linked with the PuppetDB CLI and now works with HTTPS.
+
+## [1.0.1] - 2016-06-28
+
+### Fixed
+
+- (PDB-2748) Fix incompatibility between puppet-agent 1.5 and puppet-client-tools 
+- (PDB-2653) Do not display `no error found` for bad requests
+
+## [1.0.0] - 2016-04-07
+
+### Summary
+
+Initial release of the PuppetDB CLI subcommands.
+
+The PuppetDB CLI is intended to facilitate friendlier interactions with the
+PuppetDB API. 
+
+The PuppetDB CLI accepts a configuration file with SSL credentials and the url
+for your PuppetDB server so you can issue queries to PuppetDB on your own
+machine without needing to type long `curl` invocations.
+
+We intend to use the PuppetDB CLI to provide human readable output formats and
+helpful hints for interacting with the API more generally.
+
+### Installation
+
+Please see the
+[PuppetDB documentation](https://docs.puppetlabs.com/puppetdb/master/pdb_client_tools.html)
+for installation and usage instructions.
+
+### Features
+
+- New implementations of our `puppetdb import` and `puppetdb export` tools for
+  faster startup. The commands are now Puppet subcommands `puppet-db import` and
+  `puppet-db export` respectively.
+- A `puppet-query` subcommand for querying PuppetDB with PQL or AST queries.
+
+### Contributors 
+
+Andrew Roetker, Rob Browing, Ryan Senior, and Wyatt Alt.

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# How to contribute
+
+Third-party patches are essential for keeping Puppet Labs open-source projects
+great. We want to keep it as easy as possible to contribute changes that
+allow you to get the most out of our projects. There are a few guidelines
+that we need contributors to follow so that we can have a chance of keeping on
+top of things.  For more info, see our canonical guide to contributing:
+
+[https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md](https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md)

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2016 Andrew Roetker <andrew.roetker@puppetlabs.com>
+
+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/MAINTAINERS

@@ -0,0 +1,28 @@
+{
+  "version": 1,
+  "file_format": "This MAINTAINERS file format is described at https://github.com/puppetlabs/maintainers",
+  "issues": "https://tickets.puppetlabs.com/browse/PA",
+  "internal_list": "https://groups.google.com/a/puppet.com/forum/?hl=en#!forum/discuss-puppetdb-maintainers",
+  "people": [
+    {
+      "github": "ajroetker",
+      "email": "andrew.roetker@puppet.com",
+      "name": "AJ Roetker"
+    },
+    {
+      "github": "senior",
+      "email": "ryan.senior@puppet.com",
+      "name": "Ryan Senior"
+    },
+    {
+      "github": "wkalt",
+      "email": "wyatt@puppet.com",
+      "name": "Wyatt Alt"
+    },
+    {
+      "github": "rbrw",
+      "email": "rlb@puppet.com",
+      "name": "Rob Browning"
+    }
+  ]
+}

data/README.md

@@ -0,0 +1,121 @@
+# puppetdb-cli
+
+[![Build status](https://ci.appveyor.com/api/projects/status/ip998jin18j4g0yv?svg=true)](https://ci.appveyor.com/project/puppetlabs/puppetdb-cli)
+[![Build Status](https://travis-ci.org/puppetlabs/puppetdb-cli.svg)](https://travis-ci.org/puppetlabs/puppetdb-cli)
+
+> **Note**: This repository is still under active development. Stay tuned for
+> release dates and functionality changes.
+
+The PuppetDB CLI project provide Puppet subcommands for querying PuppetDB data,
+via `puppet query <query>`, and PuppetDB administrative tasks, `puppet db
+<import|export|status>`. The `query` subcommand will allow you to query PuppetDB
+using either the upcoming PQL syntax of the traditional PuppetDB query syntax
+(also known as AST). The `db` subcommand is a replacement for the older
+`puppetdb <export|import>` commands with faster startup times and much
+friendlier error messages.
+
+## Compatibility
+
+This CLI is compatible with
+[PuppetDB 4.0.0](https://docs.puppetlabs.com/puppetdb/4.0/release_notes.html#section)
+and greater.
+
+## Installation
+
+Please see
+[the PuppetDB documentation](https://docs.puppet.com/puppetdb/latest/pdb_client_tools.html)
+for instructions on how to install the `puppet-client-tools` package.
+
+## Installation from source
+
+Using `rustc` and `cargo` (stable, beta, or nightly):
+
+```bash
+
+  $ export PATH=./target/debug:$PATH
+  $ cargo build
+  
+```
+
+When building on OSX or Windows you will also need to install openssl and use
+that for building the PuppetDB CLI. For OSX users the simplest way to do this is
+using Homebrew and running the following commands before the `cargo build`:
+
+```bash
+
+  $ export OPENSSL_LIB_DIR=$(brew --prefix)/lib
+  $ export OPENSSL_INCLUDE_DIR=$(brew --prefix)/include
+
+```
+
+## Usage
+
+Example usage:
+
+```bash
+
+$ puppet-query 'nodes[certname]{}'
+[
+  {
+    "certname" : "baz.example.com"
+  },
+  {
+    "certname" : "bar.example.com"
+  },
+  {
+    "certname" : "foo.example.com"
+  }
+]
+$ puppet-db status
+{
+  "puppetdb-status": {
+    "service_version": "4.0.0-SNAPSHOT",
+    "service_status_version": 1,
+    "detail_level": "info",
+    "state": "running",
+    "status": {
+      "maintenance_mode?": false,
+      "queue_depth": 0,
+      "read_db_up?": true,
+      "write_db_up?": true
+    }
+  },
+  "status-service": {
+    "service_version": "0.3.1",
+    "service_status_version": 1,
+    "detail_level": "info",
+    "state": "running",
+    "status": {}
+  }
+}
+
+```
+
+## Configuration
+
+The Rust PuppetDB CLI accepts a `--config=<path_to_config>` flag which allows
+you to configure your ssl credentials and the location of your PuppetDB.
+
+By default the tool will use `$HOME/.puppetlabs/client-tools/puppetdb.conf` as
+it's configuration file if it exists. You can also configure a global
+configuration (for all users) in `/etc/puppetlabs/client-tools/puppetdb.conf`
+(`C:\ProgramData\puppetlabs\client-tools\puppetdb.conf` on Windows) to fall back
+to if the per-user configuration is not present.
+
+The format of the config file can be deduced from the following example.
+
+```json
+  {
+    "puppetdb" : {
+      "server_urls" : [
+        "https://<PUPPETDB_HOST>:8081",
+        "https://<PUPPETDB_REPLICA_HOST>:8081"
+      ],
+      "cacert" : "/path/to/cacert",
+      "cert" : "/path/to/cert",
+      "key" : "/path/to/private_key",
+      "token-file" : "/path/to/token (PE only)"
+      },
+    }
+  }
+```

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+RuboCop::RakeTask.new

data/acceptance/Gemfile

@@ -0,0 +1,27 @@
+source ENV['GEM_SOURCE'] || "https://rubygems.org"
+
+def location_for(place, fake_version = nil)
+  if place =~ /^(git:[^#]*)#(.*)/
+    [fake_version, { :git => $1, :branch => $2, :require => false }].compact
+  elsif place =~ /^file:\/\/(.*)/
+    ['>= 0', { :path => File.expand_path($1), :require => false }]
+  else
+    [place, { :require => false }]
+  end
+end
+
+gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '~> 4.0')
+gem "beaker-puppet", *location_for(ENV['BEAKER_PUPPET_VERSION'] || ["~>1.0", ">= 1.0.1"])
+gem "beaker-hostgenerator", *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION'] || "~> 1.1")
+gem "beaker-abs", *location_for(ENV['BEAKER_ABS_VERSION'] || "~> 0.4")
+gem "beaker-vmpooler", *location_for(ENV['BEAKER_VMPOOLER_VERSION'] || "~> 1.3")
+unless ENV["BEAKER_TYPE"] == 'foss'
+  gem 'beaker-pe'
+  gem 'scooter', *location_for(ENV['SCOOTER_VERSION'] || '~> 4.0')
+end
+gem 'rake', '~> 12.3'
+gem 'rototiller', '= 0.1.0'
+
+if File.exists? "#{__FILE__}.local"
+    eval(File.read("#{__FILE__}.local"), binding)
+end

data/acceptance/Rakefile

@@ -0,0 +1,99 @@
+require 'rake/clean'
+require 'rototiller'
+
+desc 'Run acceptance tests'
+
+desc "Generate Beaker Host config"
+task :host_config do
+  if ENV["BEAKER_CONFIG"]
+    next
+  end
+  if not ENV['TEST_TARGET']
+    fail "FATAL: must set TEST_TARGET environment variable."
+  end
+
+  generate = "bundle exec beaker-hostgenerator"
+  generate += " --disable-default-role #{ENV['TEST_TARGET']}"
+  generate += " > hosts.cfg"
+  sh generate
+  sh "cat hosts.cfg"
+end
+
+desc "Run beaker based acceptance tests"
+task acceptance: :host_config
+task :acceptance do
+
+  # fail if SHA not present
+  fail "SHA must be set in order to setup repositories!!!" if ENV["BEAKER_TYPE"] == "pe" && !ENV['SHA']
+
+  # hardcode the pe_dir into the repo instead of the jenkins job
+  ENV['BEAKER_PE_DIR'] = "http://enterprise.delivery.puppetlabs.net/#{ENV['PE_FAMILY']}/ci-ready" unless ENV["BEAKER_TYPE"] == 'foss'
+
+  config = ENV["BEAKER_CONFIG"] || 'hosts.cfg'
+  preserve_hosts = ENV["BEAKER_PRESERVE_HOSTS"] || 'onfail'
+  type = ENV["BEAKER_TYPE"] || 'pe'
+  keyfile = ENV["BEAKER_KEYFILE"] || "#{ENV['HOME']}/.ssh/id_rsa-acceptance"
+  test_suite = ENV["BEAKER_TESTSUITE"] || "#{type}/tests/"
+  pre_suite = ENV["BEAKER_PRESUITE"] || "#{type}/setup/pre_suite"
+  opts = ENV["BEAKER_OPTS"] || ''
+
+  beaker = "bundle exec beaker "
+  beaker += " --xml"
+  beaker += " --debug"
+  beaker += " --no-color"
+  beaker += " --repo-proxy"
+  beaker += " --config #{config}" if config != ''
+  beaker += " --preserve-hosts #{preserve_hosts}" if preserve_hosts != ''
+  beaker += " --type #{type}" if type != ''
+  beaker += " --keyfile #{keyfile}" if keyfile != ''
+  beaker += " --tests #{test_suite}" if test_suite != ''
+  beaker += " --pre-suite #{pre_suite}" if pre_suite != ''
+  beaker += " #{opts}" if opts != ''
+  sh beaker
+end
+
+namespace :ci do
+  namespace :test do
+
+    desc 'This task is used by CI to test the package pe-client-tools'
+    rototiller_task :package => [:set_test_target]do |t|
+
+      flags = [
+          {:name => '--xml', :is_boolean => true},
+          {:name => '--no-color', :is_boolean => true},
+          {:name => '--debug', :is_boolean => true},
+          {:name => '--hosts', :override_env => 'BEAKER_HOSTS'},
+          {:name => '--preserve-hosts', :default => 'onfail', :override_env => 'BEAKER_PRESERVE_HOSTS'},
+          {:name => '--keyfile', :default => "#{ENV['HOME']}/.ssh/id_rsa-acceptance", :override_env => 'BEAKER_KEYFILE'},
+          {:name => '--pre-suite', :default => 'pe/setup/pre_suite', :override_env => 'BEAKER_PRESUITE'},
+          {:name => '--tests', :default => 'pe/tests', :override_env => 'BEAKER_TESTSUITE'},
+      ]
+
+      t.add_flag(*flags)
+
+      t.add_env(:name => 'SHA',           :message => 'The sha for pe-client-tools')
+      t.add_env(:name => 'SUITE_VERSION', :message => 'The suite version used by Jenkins')
+      t.add_env(:name => 'PE_FAMILY',     :message => 'The puppet enterprise major branch to install from')
+
+      t.add_env do |env|
+        env.name = 'pe_dist_dir'
+        env.message = 'The location to download PE from example "http://neptune.puppetlabs.lan/20XX.X/ci-ready"'
+        ENV['pe_dist_dir'] ||= "http://neptune.puppetlabs.lan/#{ENV['PE_FAMILY']}/ci-ready"
+      end
+
+      t.add_command({:name => 'beaker', :override_env => 'BEAKER_EXECUTABLE'})
+    end
+
+    task :set_test_target do
+      if ENV['BEAKER_HOSTS'].nil?
+        client = ENV['CLIENT_TEST_TARGET'] || (fail 'The environment variable CLIENT_TEST_TARGET must be set.')
+        # process the CLIENT_TEST_TARGET variable and assign it to TEST_TARGET so that rototiller will pick it up
+        monolithic_config = "#{client}client.mdca"
+        master_agent_config = "centos7-64.mdca-#{client}client.a"
+        ENV['BEAKER_HOSTS'] ||= (client =~ /win|osx/) ? master_agent_config : monolithic_config
+      end
+    end
+
+  end
+end
+