arfor 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63d74f24dee9d20bc39dc8ec2a4edd9914cd7db0
-  data.tar.gz: 80e38bb214b9e6a43e618a70d78f2c5f00587cb2
+  metadata.gz: 37e69a377781896f58d64cf952d3d3adb5354ba9
+  data.tar.gz: 5ad856f55141de3e2aac963903fcb5910e9bf491
 SHA512:
-  metadata.gz: 587452cf390dfb2b898a0a46ff57663afb075b1f68800b9e0bdbcecbdb1a744b3db9a363102ca3dd2e6280b198e2e2082542d251cc2ad16e2990b94c6dabf617
-  data.tar.gz: d172f044d5b7acab6bf9a46fa8c19bb847f93d2b397ec89e2e733f258910f65707ff07da93a9465c758ecb8d3e84d57cdeb0c52812b9924e8dd0be5688f54a66
+  metadata.gz: 768207f612154e3a9e06171f7ee78fe92e0c599596b5ef3754a4d06debc0d2bd05b60f42b0ed5e3692963178b29db867d3c1010649b58921fef6105bb6c4fe68
+  data.tar.gz: 300175aa21e004da8fa7f38dd3719cf844ee7e8367be9762fe99e3ae2d19cddaee0ce50c3651489425febc2a615ccb8050059e8de9e209f267626b9f4da63e39

data/README.md

@@ -22,6 +22,20 @@ Or install it yourself as:
 
 ## Usage
 
+### Making control repositories
+```
+arfor control_repo
+```
+
+#### Control Repository features
+* Fully documented
+* Based on upstream puppetlabs example
+* Built-in onceover support
+* Built-in mock-Puppetfile for use by onceover during testing
+* Hieradata validation
+* Creates a local git repo with master branch replaced with production
+
+
 ### Agent installers
 #### PE 2016.4.2 (LTS)
 ```

data/arfor.gemspec

@@ -31,4 +31,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "escort", "0.4.0"
   spec.add_runtime_dependency "pe_info", "0.1.4"
   spec.add_runtime_dependency 'ruby-progressbar', '1.8.1'
+  spec.add_runtime_dependency "octokit", "~> 4.0"
+  spec.add_runtime_dependency "highline", "1.7.8"
+  spec.add_runtime_dependency "puppet"
+  spec.add_runtime_dependency "pdqtest", "0.4.3"
+  spec.add_runtime_dependency "travis"
 end

data/exe/arfor

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 #
+# Copyright 2017 Geoff Williams for Declarative Systems PTY LTD
 # Copyright 2016 Geoff Williams for Puppet Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,6 +22,7 @@ require 'arfor/gems'
 require 'arfor/platform_installer'
 require 'pe_info/tarball'
 require 'arfor/control_repo'
+require 'arfor/github_module'
 
 # display help if nothing specified
 ARGV.push('-h') if ARGV.empty?
@@ -116,5 +118,14 @@ Escort::App.create do |app|
         Arfor::ControlRepo::create()
       end
     end
+
+    app.command :github_module do |command|
+      command.summary "Github Module"
+      command.description "Create a new Puppet module enabled with PDQTest and upload to GitHub"
+      command.action do |options, arguments|
+        puts Arfor::GithubModule::create()
+      end
+    end
+
   end
 end

data/lib/arfor/control_repo.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 #
+# Copyright 2017 Geoff Williams for Declarative Systems PTY LTD
 # Copyright 2016 Geoff Williams for Puppet Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/arfor/github_module.rb

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2017 Geoff Williams for Declarative Systems PTY LTD
+#
+# 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 'octokit'
+require "highline/import"
+require "arfor/util/github"
+require "json"
+
+module Arfor
+  module GithubModule
+    PUPPET_METADATA = 'metadata.json'
+    README_FILE     = 'README.md'
+    README_ERB      = "../../res/puppet_module/#{README_FILE}.erb"
+
+    def self.create()
+
+      # http://stackoverflow.com/a/2889747/3441106
+      forge_name  = ask("#{Arfor::QUESTION} Forge module name: ") do |q|
+        q.validate = /[\w_]+-[\w_]+/
+      end
+      description = ask("#{Arfor::QUESTION} Module description: ")
+
+      forge_name_split  = forge_name.split('-')
+      forge_user        = forge_name_split[0]
+      module_name       = forge_name_split[1]
+
+      git_name    = "puppet-#{module_name}"
+
+      git_opts    = {
+        :description => description,
+      }
+
+      # Step 1 - generate puppet module
+      if system("puppet module generate --skip-interview #{forge_name}")
+
+        Dir.chdir(module_name) {
+
+          # temporary ;-) fix for needing to replace the Gemfile
+          File.delete('Gemfile')
+
+          # Step 2 - install PDQtest
+          system("pdqtest init")
+
+          # Step 3 - make remote git repo
+          begin
+            resp = Arfor::Util::Github::create_repository(git_name, git_opts)
+            full_name = resp.full_name
+          rescue Octokit::UnprocessableEntity => e
+            raise "Repository creation error:  #{e.message}"
+          end
+
+          # Step 4 - doco template
+          template  = File.read(File.join(File.dirname(File.expand_path(__FILE__)), README_ERB))
+          content   = ERB.new(template, nil, '-').result(binding)
+          File.write(README_FILE, content)
+
+          # Step 5 - checkout local copy of git repo, merge changes and upload
+          system("git init && git remote add origin #{resp.clone_url}")
+
+          # Step 6 - update puppet metdata.json with settings from git
+          metadata = JSON.parse(File.read(PUPPET_METADATA))
+          metadata['source']      = resp.clone_url
+          metadata['project_url'] = resp.clone_url
+          metadata['issues_url']  = resp.issues_url
+          metadata['summary']     = description
+          File.write(PUPPET_METADATA, JSON.pretty_generate(metadata))
+
+          # Step 7 - cleanup backup crud files
+          Dir.glob("**/*.pdqtest_old").each { |f|
+            File.delete(f)
+          }
+
+          # Step 8 - Enable travis (you need to have already logged yourself in)
+          # the sleep is to allow time for the apis to settle before travis does
+          # its scans
+          puts "sleep for sync"
+          sleep(30)
+          system("travis enable --no-interactive")
+
+          # Step 9 - initial git commit and upload changes
+          system("git add -A && git commit -m 'initial' && git push origin master")
+        }
+      else
+        raise "module generation error"
+      end
+
+      Arfor::OK
+    end
+
+
+  end
+end

data/lib/arfor/platform_installer.rb

@@ -19,7 +19,6 @@ require 'etc'
 module Arfor
   module PlatformInstaller
     BASE_URL            = "https://pm.puppetlabs.com/cgi-bin/download.cgi?"
-    LICENCE_FILE        = "#{Etc.getpwuid.dir}/.arfor/licence.key"
     BASE_TARGET         = "puppet-enterprise-"
     SUFFIX_TARGET       = ".tar.gz"
 
@@ -30,8 +29,8 @@ module Arfor
 
     def self.licence_check
       licenced = false
-      if File.exist?(LICENCE_FILE)
-        licenced = File.foreach(LICENCE_FILE).grep(/thanks for registering/)
+      if File.exist?(Arfor::LICENCE_FILE)
+        licenced = File.foreach(Arfor::LICENCE_FILE).grep(/thanks for registering/)
       end
 
       if ! licenced

data/lib/arfor/util/github.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2017 Geoff Williams for Declarative Systems PTY LTD
+#
+# 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 "highline/import"
+
+module Arfor
+  module Util
+    module Github
+
+      def self.read_token
+        if File.exists?(Arfor::TOKEN_FILE)
+          token = File.read(Arfor::TOKEN_FILE)
+        else
+          token = ask "#{Arfor::QUESTION} Github token (https://github.com/settings/tokens/new): "
+          write_token(token)
+        end
+
+        token
+      end
+
+      def self.write_token(token)
+        File.write(Arfor::TOKEN_FILE, token)
+      end
+
+      def self.create_repository(git_name, git_opts)
+        puts "creating #{git_name}"
+        client = Octokit::Client.new(:access_token => read_token)
+        # user = client.user
+        # puts user.login
+        resp = client.create_repository(git_name, git_opts)
+
+        resp
+      end
+    end
+  end
+end

data/lib/arfor/version.rb

@@ -15,5 +15,5 @@
 # limitations under the License.
 
 module Arfor
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/arfor.rb

@@ -15,7 +15,16 @@
 # limitations under the License.
 
 require "arfor/version"
+require "etc"
 
 module Arfor
   # Your code goes here...
+  CONFIG_DIR    = "#{Etc.getpwuid.dir}/.arfor"
+  LICENCE_FILE  = "#{CONFIG_DIR}/licence.key"
+  TOKEN_FILE    = "#{CONFIG_DIR}/github_token"
+  TRAVIS_CONF   = "#{Etc.getpwuid.dir}/.travis/config.yml"
+  QUESTION      = "🤖"
+  OK            = "👍"
+  ERROR         = "💩"
+
 end

data/res/puppet_module/README.md.erb

@@ -0,0 +1,46 @@
+[![Build Status](https://travis-ci.org/<%= full_name %>.svg?branch=master)](https://travis-ci.org/<%= full_name %>)
+# <%= module_name %>
+
+#### Table of Contents
+
+1. [Description](#description)
+1. [Usage - Configuration options and additional functionality](#usage)
+1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
+1. [Limitations - OS compatibility, etc.](#limitations)
+1. [Development - Guide for contributing to the module](#development)
+
+## Description
+
+<%= description %>
+
+## Usage
+See reference and examples
+
+## Reference
+[generated documentation](https://rawgit.com/<%= full_name %>/master/doc/index.html).
+
+Reference documentation is generated directly from source code using [puppet-strings](https://github.com/puppetlabs/puppet-strings).  You may regenerate the documentation by running:
+
+```shell
+bundle exec puppet strings
+```
+
+## Limitations
+* Not supported by Puppet, Inc.
+
+## Development
+
+PRs accepted :)
+
+## Testing
+This module supports testing using [PDQTest](https://github.com/declarativesystems/pdqtest).
+
+
+Test can be executed with:
+
+```
+bundle install
+make
+```
+
+See `.travis.yml` for a working CI example

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arfor
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Geoff Williams
@@ -122,6 +122,76 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+- !ruby/object:Gem::Dependency
+  name: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pdqtest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+- !ruby/object:Gem::Dependency
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: make puppet installers quicker and more reliable
 email:
 - geoff.williams@puppet.com
@@ -146,12 +216,15 @@ files:
 - lib/arfor/control_repo.rb
 - lib/arfor/download.rb
 - lib/arfor/gems.rb
+- lib/arfor/github_module.rb
 - lib/arfor/platform_installer.rb
+- lib/arfor/util/github.rb
 - lib/arfor/version.rb
 - res/control_repo/Gemfile
 - res/control_repo/Makefile
 - res/control_repo/Puppetfile.mock
 - res/control_repo/README.md
+- res/puppet_module/README.md.erb
 homepage: https://github.com/GeoffWilliams/arfor/
 licenses:
 - Apache-2.0