pe_info 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f1d46674fe37394b392fc487bba0b02f389622f
-  data.tar.gz: 62dbf3e448126727560f1dff41f6de937b926025
+  metadata.gz: 4489b5366f96844f0c511030e49986133d224e7e
+  data.tar.gz: 2ab2613f979ddaeb6c8030f72cd0503bbe68c952
 SHA512:
-  metadata.gz: 3223cb7cc69bd9add32c8a85c60f86cd0d37689d18502073e782b34ae999707e6d78bd36dc35e19870e23418e56d9d2070718741794a7968ba34163067252adc
-  data.tar.gz: 2d9798a5d04ad530d248be7c132596d892da99dcf112091d64b247651c6a5083ec133a9bf8453e3708811f1b1b45efb875b845d81598f39be0e672cc0db1d9f8
+  metadata.gz: e65248cebe0cd9c7eed9c49b025364373b3fc6d0116dbe66efbcc7d0edc7e1b0ba0a8c2659bd33dac0ba95fa5347038f6d0670c14098a834e2fff34126cf53d5
+  data.tar.gz: 2a6e516f1e91b9654d2153921fd958c7e119f858933e43848bd95e70cd6f2640ce49979a3106bc58d2cee46331afe97608a3d8d568f886063760af1dc05b85f3

data/.gitignore

@@ -1,3 +1,4 @@
+*.gem
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/README.md

@@ -1,8 +1,12 @@
+[![Build Status](https://travis-ci.org/GeoffWilliams/pe_info.svg?branch=master)](https://travis-ci.org/GeoffWilliams/pe_info)
 # PeInfo
 
-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/pe_info`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is a simple library for figuring out things we need to know about Puppet
+Enterprise, such as where to upload agent installers and what the agent version
+number is.
 
-TODO: Delete this and the text above, and describe your gem
+This is done by either munging supplied version arguments or in the case of
+agent versions, looking inside of an installation media tarball.
 
 ## Installation
 
@@ -22,7 +26,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Uploading agent installers
+
+Lets say you have an agent installer tarball you previously downloaded:
+```
+...
+38M /Users/geoff/agent_installers/2016.5.1/puppet-agent-sles-10-x86_64.tar.gz
+25M /Users/geoff/agent_installers/2016.5.1/puppet-agent-sles-11-i386.tar.gz
+33M /Users/geoff/agent_installers/2016.5.1/puppet-agent-sles-11-s390x.tar.gz
+...
+```
+
+And you would like to know where it should be uploaded on a server you just
+installed with PE 2016.5.1 from `/Users/geoff/Downloads/puppet-enterprise-2016.5.1-el-7-x86_64.tar.gz`:
+
+```ruby
+require 'pe_info'
+tarball = '/Users/geoff/Downloads/puppet-enterprise-2016.5.1-el-7-x86_64.tar.gz'
+pe_version, agent_version = PeInfo::Tarball::inspect(tarball)
+if pe_version and agent_version
+  upload_path = PeInfo::System::agent_installer_upload_path(
+    pe_version,
+    agent_version,
+    repo_file
+  )
+
+  if upload_path
+    # do something with upload_path
+  else
+    # unparsable agent_version
+  end
+else
+  # install tarball missing or invalid
+end
+```
+
+Now you know that the agent installers tarball belongs at `upload_path`.  If you upload the file to this location on a PE master, it will remove the need to head out to the internet and download the file manually.
 
 ## Development
 
@@ -32,5 +71,30 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pe_info.
+Bug reports and pull requests are welcome on GitHub at https://github.com/GeoffWilliams/pe_info.
+
+Please ensure tests are passing before and after any contributions and please update tests as required for new functionality and bugfixes:
+
+```
+bundle install
+bundle exec rake spec
+```
+
+### Creating mock PE tarballs
+To create a PE tarball identical to a release but with every file truncated to zero bytes:
+
+```shell
+mkdir tmp
+cd tmp
+tar zxvf PE_UPSTREAM_TARBALL
+cd puppet-enterprise-*
+find . -type f -exec truncate -s 0 {} \;
+cd ..
+tar zcvf MOCK_PE_UPSTREAM_TARBALL puppet-enterprise-*
+```
+
+Once created, the tarball can be moved to spec/fixtures/tarballs and the tmp directory can be removed
 
+## Support
+* This is experimental software, use at own risk!
+* This software is not supported by Puppet, Inc.

data/lib/pe_info/system.rb

@@ -1,3 +1,18 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2016 Geoff Williams for Puppet 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.
 module PeInfo
   module System
     AGENT_UPLOAD_PATH_NORMAL  = '/opt/puppetlabs/server/data/staging'
@@ -16,7 +31,7 @@ module PeInfo
       "/#{AGENT_UPLOAD_PATH_WINDOWS}/#{pe_version}/windows-x86_64-#{agent_version}"
     end
 
-    def self.upload_path(pe_version, agent_version, installer)
+    def self.agent_installer_upload_path(pe_version, agent_version, installer)
       if installer =~ /puppet-agent-x64.msi/
         path = agent_installer_upload_path_windows_x64(pe_version, agent_version)
       elsif installer =~ /puppet-agent-x86.msi/

data/lib/pe_info/tarball.rb

@@ -1,25 +1,62 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2016 Geoff Williams for Puppet 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.
 require "pe_info/version"
 
 module PeInfo
   module Tarball
+    def self.tar
+      begin
+        tar_version = %x(tar --version)
+        if tar_version =~ /GNU/
+          tar = 'tar --wildcards '
+        else
+          tar = 'tar'
+        end
+      rescue Errno::ENOENT
+        raise "please install tar and make sure its in your PATH"
+      end
+
+      tar
+    end
+
     def self.is_pe_tarball(tarball)
-      tarball =~ /puppet-enterprise-\d{4}\.\d+\.\d+.*\.tar\.gz/
+      # =~ returns nil if no matches or position of first match so we must
+      # convert its result to a boolean for easy use
+      tarball =~ /puppet-enterprise-\d{4}\.\d+\.\d+.*\.tar\.gz/ ? true : false
     end
 
     def self.pe_version(tarball)
-      pe_version = tarball.match(/puppet-enterprise-(\d{4}\.\d+\.\d+)/).captures.first
+      matches = tarball.match(/puppet-enterprise-(\d{4}\.\d+\.\d+)/)
+      pe_version = matches ? matches.captures.first : false
 
       pe_version
     end
 
     def self.agent_version(tarball)
-      agent_package = %x(tar ztf #{tarball} '**/puppet-agent*')
-      agent_version = agent_package.match(/puppet-agent-(\d+\.\d+\.\d+)/).captures.first
+      agent_package = %x(#{tar} -ztf #{tarball} '*/puppet-agent*')
+      matches = agent_package.match(/puppet-agent-(\d+\.\d+\.\d+)/)
+      agent_version = matches ? matches.captures.first : false
 
       agent_version
     end
 
     def self.inspect(tarball)
+      pe_version    = false
+      agent_version = false
+
       if is_pe_tarball(tarball)
         if File.exists?(tarball)
 
@@ -29,10 +66,10 @@ module PeInfo
           # look for the agent version
           agent_version = agent_version(tarball)
         else
-          raise "File not found: #{tarball}"
+          PeInfo.logger.debug "File not found: #{tarball}"
         end
       else
-        raise "Not a puppet install tarball: #{tarball}"
+        PeInfo.logger.debug "Not a puppet install tarball: #{tarball}"
       end
       return pe_version, agent_version
     end

data/lib/pe_info/version.rb

@@ -1,3 +1,18 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2016 Geoff Williams for Puppet 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.
 module PeInfo
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

data/lib/pe_info.rb

@@ -1,3 +1,31 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2016 Geoff Williams for Puppet 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.
+require 'logger'
+
 module PeInfo
 
+  # lazy-init logger to be a regular ruby logger instance.  If you want
+  # something else, call logger= before doing things that generate logging
+  # ...based on http://stackoverflow.com/a/6768164
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pe_info
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Geoff Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler