vanagon 0.14.2 → 0.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23f0195398b4d15d4289b46a80de1173c8cb62d3
-  data.tar.gz: 1b4ed247fb06c882cbb25bcd2136c2111e1d975e
+  metadata.gz: dfdf9e485d076f8615fb5dec7ee3659bdb30cadf
+  data.tar.gz: 11c28aee93eaa0c737ceb44fc6152bef2d5fe421
 SHA512:
-  metadata.gz: c40f47dd2bd836eed0a234e499d5f2a0463111b0dc8f7d3d9496666d3639b926717cfcac105fc9fee76a7478e0caa40ecef3de27c6d70fe25857ca2918afecfe
-  data.tar.gz: 7704989004ce1ff9f26149340535215b2be532ac1b7c57045b5532a21a8563fa0170addf59369c734ec73dc14f65b5406207f6e4bb67b0a07d9022a6addcf254
+  metadata.gz: d88904c2f719cbd894784ef42792b78dbcf7c407eea7320f80e208780de4e60858aad4835109a94018a956b3596732226c48131488efd6b10dc95ae54ca816bf
+  data.tar.gz: a934492d38471190d3c984d2ff35a6d87bbf459ade415d44e39a68a2c48639845e7c7831bb360f4c99bb09e06b9478642dc18f07ef619186a1e44c50d84ecf54

data/README.md

@@ -9,13 +9,13 @@
   - [Local Host:](#local-host)
   - [Remote Build Target:](#remote-build-target)
 - [Configuration and Usage](#configuration-and-usage)
+  - [Overview](#overview)
   - [`build` usage](#build-usage)
   - [`inspect` usage](#inspect-usage)
 - [Engines](#engines)
   - [Amazon Ec2](#amazon-ec2)
 - [Contributing](#contributing)
 - [License](#license)
-- [Overview](#overview)
 - [Maintainers](#maintainers)
 
 <!-- /MarkdownTOC -->
@@ -26,7 +26,8 @@
 Vanagon is a tool to build a single package out of a project, which can itself
 contain one or more components. This tooling is being used to develop the
 puppet-agent package, which contains components such as openssl, ruby, and
-augeas among others. For a simple example, please see the project in the `examples/` directory.
+augeas among others. For a simple example, please see the project in the
+[`examples/`](examples) directory.
 
 Vanagon builds up a Makefile and packaging files (specfile for RPM,
 control/rules/etc for DEB) and copies them to a remote host, where make can be
@@ -71,6 +72,18 @@ Vanagon won't be much use without a project to build. Beyond that, you must
 define any platforms you want to build for. Vanagon ships with some simple
 binaries to use, but the one you probably care about is named 'build'.
 
+### Overview
+
+Vanagon is broken down into three core ideas: the project, the component and
+the platform. The project contains one or more components and is built for a
+platform. As a quick example, if I had a ruby app and wanted to package it, the
+project would probably contain a component for ruby and a component for my app.
+If I wanted to build it for debian wheezy, I would define a platform called
+wheezy and build my project against it.
+
+For more detailed examples of the DSLs available, please see the
+[examples](examples) directory and the YARD documentation for Vanagon.
+
 ### `build` usage
 The build command has positional arguments and position independent flags.
 
@@ -281,24 +294,12 @@ end
 Contributing
 ---
 We'd love to get contributions from you! Once you are up and running, take a look at the
-[Contribution Documents](https://github.com/puppetlabs/vanagon/blob/master/docs/CONTRIBUTING.md) to see how to get your changes merged
+[Contribution Documents](docs/CONTRIBUTING.md) to see how to get your changes merged
 in.
 
 License
 ---
-See [LICENSE](https://github.com/puppetlabs/vanagon/blob/master/LICENSE) file.
-
-Overview
----
-Vanagon is broken down into three core ideas: the project, the component and
-the platform. The project contains one or more components and is built for a
-platform. As a quick example, if I had a ruby app and wanted to package it, the
-project would probably contain a component for ruby and a component for my app.
-If I wanted to build it for debian wheezy, I would define a platform called
-wheezy and build my project against it.
-
-For more detailed examples of the DSLs available, please see the
-[examples](https://github.com/puppetlabs/vanagon/tree/master/examples) directory and the YARD documentation for Vanagon.
+See [LICENSE](LICENSE) file.
 
 ## Maintainers
-See MAINTAINERS file.
+See [MAINTAINERS](MAINTAINERS) file.

data/bin/ship

@@ -6,6 +6,16 @@ ENV["PROJECT_ROOT"] = Dir.pwd
 # This is not intended to function outside of Puppet Labs' infrastructure.
 # End of warning.
 
+artifactory_warning = <<-DOC
+  Unable to ship packages to artifactory. Please make sure you are pointing to a
+  recent version of packaging in your Gemfile. Please also make sure you include
+  the artifactory gem in your Gemfile.
+
+  i.e.,
+  gem 'packaging', :github => 'puppetlabs/packaging', branch: '1.0.x'
+  gem 'artifactory'
+DOC
+
 if Dir["output/**/*"].select { |entry| File.file?(entry) }.empty?
   fail "No packages to ship in the output directory. Maybe you want to build some first?"
 else
@@ -15,14 +25,8 @@ else
   begin
     Pkg::Util::RakeUtils.invoke_task('pl:jenkins:ship_to_artifactory', 'output')
   rescue LoadError
-    warn <<-DOC
-  Unable to ship packages to artifactory. Please make sure you are pointing to a
-  recent version of packaging in your Gemfile. Please also make sure you include
-  the artifactory gem in your Gemfile.
-
-  i.e.,
-  gem 'packaging', :github => 'puppetlabs/packaging', branch: '1.0.x'
-  gem 'artifactory'
-    DOC
+    warn artifactory_warning
+  rescue
+    warn artifactory_warning
   end
 end

data/lib/vanagon.rb

@@ -10,3 +10,7 @@ $:.unshift(LIBDIR) unless
 
 require 'vanagon/optparse'
 require 'vanagon/driver'
+
+# The main entry point is {Vanagon::Driver}.
+class Vanagon
+end

data/lib/vanagon/common/pathname.rb

@@ -21,7 +21,7 @@ class Vanagon
       #     representing the group name of the owner of self.
       attr_accessor :path, :mode, :owner, :group
 
-      # Each Pathname requires a filesystem path, and has many optional
+      # Each {Pathname} requires a filesystem path, and has many optional
       # properties that may be set at initialization time.
       # @param [String, Integer] mode the UNIX Octal permission string to use when this file is archived
       # @param [String, Integer] owner the username or UID to use when this file is archived
@@ -38,17 +38,17 @@ class Vanagon
       end
 
       # An alias to {Vanagon::Common::Pathname}'s constructor method,
-      #   which returns a new Vanagon::Common::Pathname, explicitly marked as a file
+      #   which returns a new {Vanagon::Common::Pathname}, explicitly marked as a file
       # @see Vanagon::Common::Pathname#initialize
       #
-      # @example Create a new Vanagon::Common::Pathname, marked as a file.
+      # @example Create a new {Vanagon::Common::Pathname}, marked as a file.
       #   Vanagon::Common::Pathname.file('/etc/puppet/puppet/puppet.conf')
       def self.file(path, **args)
         new(path, **args.merge!({ config: false }))
       end
 
       # An alias to {Vanagon::Common::Pathname}'s constructor method,
-      #   which returns a new Vanagon::Common::Pathname, explicitly marked as a configuration file
+      #   which returns a new {Vanagon::Common::Pathname}, explicitly marked as a configuration file
       # @see Vanagon::Common::Pathname#initialize
       #
       # @example Create a new configuration file, marked as a configuration file.
@@ -69,9 +69,9 @@ class Vanagon
         !!(@mode || @owner || @group)
       end
 
-      # Equality -- Two instances of Vanagon::Common::Pathname are equal if they
+      # Equality -- Two instances of {Vanagon::Common::Pathname} are equal if they
       #   contain the same number attributes and if each attribute is equal to
-      #   (according to {Object#==}) the corresponding attribute in other_pathname.
+      #   (according to `Object#==`) the corresponding attribute in other_pathname.
       #
       # @return [Boolean] true if all attributes have equal values, or otherwise false.
       def ==(other)
@@ -79,8 +79,11 @@ class Vanagon
       end
       alias :eql? :==
 
-      # @return [Fixnum] Compute a hash-code for self, derived from its attributes;
-      #   two Pathnames with the same content will have the same hash code (and will compare using {#eql?}).
+      # Compute a hash-code for self, derived from its attributes. Two
+      # {Pathname} objects with the same content will have the same hash code
+      # (and will compare as equal using {#eql?})
+      #
+      # @return [Fixnum]
       def hash
         instance_variables.map { |v| instance_variable_get(v) }.hash
       end

data/lib/vanagon/engine/always_be_scheduling.rb

@@ -3,8 +3,8 @@ require 'json'
 
 class Vanagon
   class Engine
-    # This engine allows build resources to be managed by the "Always be
-    # Scheduling" (ABS) scheduler (https://github.com/puppetlabs/always-be-scheduling)
+    # This engine allows build resources to be managed by the ["Always be
+    # Scheduling" (ABS) scheduler](https://github.com/puppetlabs/always-be-scheduling)
     #
     # ABS expects to ask `build_host_info` for the needed resources for a build,
     # and to have that return a platform name.  ABS will then acquire the
@@ -18,53 +18,69 @@ class Vanagon
     # `build_host_info ... --engine always_be_scheduling` is specified on the
     # command-line.
     #
-    # Configuration:
+    # Configuration
+    # -------------
     #
     # Project platform configurations can specify the platform name to be returned
     # via the `abs_resource_name` attribute. If this is not set but `vmpooler_template`
     # is set, then the `vmpooler_template` value will be used. Otherwise, the
     # platform name will be returned unchanged.
     #
-    # Example 1:
+    # Example 1
+    # ---------
     #
+    # ```
     # platform 'ubuntu-10.04-amd64' do |plat|
     #   plat.vmpooler_template 'ubuntu-1004-amd64'
     # end
+    # ```
     #
+    # ```
     # $ build_host_info puppet-agent ubuntu-10.04-amd64
     # {"name":"ubuntu-10.04-amd64","engine":"pooler"}
     #
     # $ build_host_info puppet-agent ubuntu-10.04-amd64 --engine always_be_scheduling
     # {"name":"ubuntu-10.04-amd64","engine":"always_be_scheduling"}
+    # ```
     #
     #
-    # Example 2:
+    # Example 2
+    # ---------
     #
+    # ```
     # platform 'aix-5.3-ppc' do |plat|
     #   plat.build_host ['aix53-builder-1.example.com']
     #   plat.abs_resource_name 'aix-53-ppc'
     # end
+    # ```
     #
+    # ```
     # $ build_host_info puppet-agent aix-5.3-ppc
     # {"name":"aix53-builder-1.example.com","engine":"hardware"}
     #
     # $ build_host_info puppet-agent aix-5.3-ppc --engine always_be_scheduling
     # {"name":"aix-53-ppc","engine":"always_be_scheduling"}
+    # ```
     #
     #
-    # Example 3:
+    # Example 3
+    # ---------
     #
+    # ```
     # platform 'aix-5.3-ppc' do |plat|
     #   plat.build_host ['aix53-builder-1.example.com']
     #   plat.vmpooler_template
     #   plat.abs_resource_name 'aix-53-ppc'
     # end
+    # ```
     #
+    # ```
     # $ build_host_info puppet-agent aix-5.3-ppc
     # {"name":"aix53-builder-1.example.com","engine":"hardware"}
     #
     # $ build_host_info puppet-agent aix-5.3-ppc --engine always_be_scheduling
     # {"name":"aix-53-ppc","engine":"always_be_scheduling"}
+    # ```
     class AlwaysBeScheduling < Base
       def initialize(platform, target, **opts)
         super

data/lib/vanagon/environment.rb

@@ -50,6 +50,7 @@ class Vanagon
     # Associates the value given by value with the key given by key. Keys will
     # be cast to Strings, and should conform to the Open Group's guidelines for
     # portable shell variable names:
+    #
     #     Environment variable names used by the utilities in the Shell and
     #     Utilities volume of IEEE Std 1003.1-2001 consist solely of uppercase
     #     letters, digits, and the '_' (underscore) from the characters defined

data/lib/vanagon/extensions/hashable.rb

@@ -18,9 +18,10 @@ module HashableAttributes
   end
 end
 
-# Vanagon classes generally don't implement JSON or Hash functionality
-# so those need to be monkey-patched for useful inspection.
 class Vanagon
+  # Vanagon classes generally don't implement JSON or Hash functionality
+  # so those need to be monkey-patched for useful inspection.
+
   class Platform
     include HashableAttributes
   end

data/lib/vanagon/platform.rb

@@ -28,7 +28,7 @@ class Vanagon
     attr_accessor :defaultdir
 
     # Each of these holds the path or name of the command in question,
-    # e.g. `copy = "/usr/local/bin/gcp"`, or `copy = "cp"
+    # e.g. `copy = "/usr/local/bin/gcp"`, or `copy = "cp"`
     attr_accessor :copy
     attr_accessor :find
     attr_accessor :install
@@ -42,14 +42,14 @@ class Vanagon
     # Hold a string containing the values that a given platform
     # should use when a Makefile is run - resolves to the CFLAGS
     # and LDFLAGS variables. This should be changed to take advantage
-    # of the Environment, so that we can better leverage Make's
-    # Implicit Variables:
-    #   https://www.gnu.org/software/make/manual/html_node/Implicit-Variables.html
+    # of the {Vanagon::Environment}, so that we can better leverage Make's
+    # {https://www.gnu.org/software/make/manual/html_node/Implicit-Variables.html Implicit Variables}.
+    #
     # It should also be extended to support CXXFLAGS and CPPFLAGS ASAP.
     attr_accessor :cflags
     attr_accessor :ldflags
 
-    # The overall Environment that a given platform
+    # The overall {Vanagon::Environment} that a given platform
     # should pass to each component
     attr_accessor :environment
 

data/lib/vanagon/platform/rpm/aix.rb

@@ -1,8 +1,8 @@
-# AIX is special. This subclassing gives us the chance to define some sane
-# defaults for aix without cluttering the main rpm class in if statements.
 class Vanagon
   class Platform
     class RPM
+      # AIX is special. This subclassing gives us the chance to define some sane
+      # defaults for aix without cluttering the main rpm class in if statements.
       class AIX < Vanagon::Platform::RPM
         def rpm_defines
           %(--define '_topdir $(tempdir)/rpmbuild' )

data/lib/vanagon/platform/rpm/sles.rb

@@ -1,8 +1,8 @@
-# SLES is special, mainly in the differences between yum and zypper,
-# so here we subclass SLES off of rpm.
 class Vanagon
   class Platform
     class RPM
+      # SLES is special, mainly in the differences between yum and zypper,
+      # so here we subclass SLES off of rpm.
       class SLES < Vanagon::Platform::RPM
         # Helper to setup a zypper repository on a target system
         #

data/lib/vanagon/platform/rpm/wrl.rb

@@ -1,11 +1,11 @@
-# This platform definition was created to account for oddities with
-# the RPM available on WindRiver Linux based systems. WRL uses RPMv5
-# and some of the WRL-based OS platforms we support (e.g, HuaweiOS)
-# do not have package repo systems or support for installing remote
-# RPMs via urls
 class Vanagon
   class Platform
     class RPM
+      # This platform definition was created to account for oddities with
+      # the RPM available on WindRiver Linux based systems. WRL uses RPMv5
+      # and some of the WRL-based OS platforms we support (e.g, HuaweiOS)
+      # do not have package repo systems or support for installing remote
+      # RPMs via urls
       class WRL < Vanagon::Platform::RPM
         # Some WRL RPM platforms (e.g, HuaweiOS) don't allow you to
         # install remote packages via url, so we'll do a dance to

data/lib/vanagon/platform/windows.rb

@@ -71,6 +71,7 @@ class Vanagon
 
       # Method to recursively copy from a source project resource directory
       # to a destination (wix) work directory.
+      #
       # strongly suspect the original cp_r command would have done all of this.
       #
       # @param proj_resources [String] Project Resource File directory
@@ -81,7 +82,8 @@ class Vanagon
       end
 
       # Method to merge in the files from the Vanagon (generic) directories.
-      # Project Specific files take precedence, so since these are copied prior
+      #
+      # Project specific files take precedence, so since these are copied prior
       # to this function, then this merge operation will ignore existing files
       #
       # @param vanagon_root [String] Vanagon wix resources directory
@@ -143,13 +145,14 @@ class Vanagon
       end
 
       # The specific bits used to generate a windows nuget package for a given project
-      # Nexus expects packages to be named #{name}-#{version}.nupkg. However, chocolatey
-      # will generate them to be #{name}.#{version}.nupkg. So, we have to rename the
+      #
+      # Nexus expects packages to be named `#{name}-#{version}.nupkg`. However, chocolatey
+      # will generate them to be `#{name}.#{version}.nupkg`. So, we have to rename the
       # package after we build it.
       #
       # @param project [Vanagon::Project] project to build a nuget package of
       # @return [Array] list of commands required to build a nuget package for
-      # the given project from a tarball
+      #   the given project from a tarball
       def generate_nuget_package(project) # rubocop:disable Metrics/AbcSize
         target_dir = project.repo ? output_dir(project.repo) : output_dir
         ["mkdir -p output/#{target_dir}",
@@ -163,11 +166,13 @@ class Vanagon
       end
 
       # The specific bits used to generate a windows msi package for a given project
+      #
       # Have changed this to reflect the overall commands we need to generate the package.
       # Question - should we break this down into some simpler Make tasks ?
-      # 1. Heat the directory tree to produce the file list
-      # 2. Compile (candle) all the wxs files into wixobj files
-      # 3. Run light to produce the final MSI
+      #
+      #    1. Heat the directory tree to produce the file list
+      #    2. Compile (candle) all the wxs files into wixobj files
+      #    3. Run light to produce the final MSI
       #
       # @param project [Vanagon::Project] project to build a msi package of
       # @return [Array] list of commands required to build an msi package for the given project from a tarball
@@ -228,6 +233,7 @@ class Vanagon
       end
 
       # Method to derive the package name for the project.
+      #
       # Neither chocolatey nor nexus know how to deal with architecture, so
       # we are just pretending it's part of the package name.
       #
@@ -261,12 +267,14 @@ class Vanagon
       # determine what version type to deliver.
       #
       # Examples of final versions:
-      #   1.2.3
-      #   1.5.3.1
+      #
+      #    * 1.2.3
+      #    * 1.5.3.1
       #
       # Examples of prerelease versions:
-      #   1.2.3.1234-g124dm9302
-      #   3.2.5.23-gd329nd
+      #
+      #    * 1.2.3.1234-g124dm9302
+      #    * 3.2.5.23-gd329nd
       #
       # @param project [Vanagon::Project] project to version
       # @return [String] the version of the nuget package for this project
@@ -281,6 +289,7 @@ class Vanagon
       end
 
       # Add a repository (or install Chocolatey)
+      #
       # Note - this only prepares the list of commands to be executed once the Platform
       # has been setup
       #
@@ -304,13 +313,14 @@ class Vanagon
         commands
       end
 
-      # Generate the underlying directory structure of
-      # any binary files referenced in services. note that
-      # this function does not generate the structure of
-      # the installation directory, only the structure above it.
+      # Generate the underlying directory structure of any binary files
+      # referenced in services.
+      #
+      # Note that this function does not generate the structure of the
+      # installation directory, only the structure above it.
       #
-      # @param services, list of all services in a project
-      # @param project, actual project we are creating the directory structure for
+      # @param services list of all services in a project
+      # @param project actual project we are creating the directory structure for
       def generate_service_bin_dirs(services, project)
         # All service files will need a directory reference
         items = services.map do |svc|
@@ -389,7 +399,7 @@ class Vanagon
       # Recursively generate wix element structure
       #
       # @param root, the (empty) root of an n-ary tree containing the
-      # structure of directories
+      #   structure of directories
       def generate_wix_from_graph(root)
         string = ''
         unless root[:children].empty?
@@ -409,7 +419,7 @@ class Vanagon
       end
 
       # Grab only the first three values from the version input
-      # and strip off any non-digit characters.\
+      # and strip off any non-digit characters.
       #
       # @param [string] version, the original version number
       def wix_product_version(version)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vanagon
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.14.3
 platform: ruby
 authors:
 - Puppet Labs