pdksync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5260a9b4d496039fb943d35a3505fd6491b67981
+  data.tar.gz: ae071b8c16b894de1afe41b9a972132fdee4471f
+SHA512:
+  metadata.gz: 429b87f768527fedfb9c9d72712995c61364c159c35a67f6639c7be1db497a8feebb79a87c7b2b8ffc3a5b8d1cc9eb3e91ddffb9358a6836fbb703d32b7315fb
+  data.tar.gz: c5c52a3fe2e4389cebcbc5ff314991cf47cbf003962d0b41451cb834039156ba1aae54520a843a22cf954c71c10748c1b966fccbbb843aad72d5bc5974ef508a

data/.gitignore

@@ -0,0 +1,5 @@
+tmp/
+modules/
+*.gem
+Gemfile.lock
+.bundle/

data/.rubocop.yml

@@ -0,0 +1,84 @@
+---
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: '2.1'
+  Include:
+  - "./**/*.rb"
+  Exclude:
+  - bin/*
+  - ".vendor/**/*"
+  - Gemfile
+  - Rakefile
+  - pkg/**/*
+  - spec/fixtures/**/*
+  - vendor/**/*
+  - modules_pdksync/**/*
+Metrics/LineLength:
+  Description: People have wide screens, use them.
+  Max: 200
+Style/BlockDelimiters:
+  Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to
+    be consistent then.
+  EnforcedStyle: braces_for_chaining
+Style/ClassAndModuleChildren:
+  Description: Compact style reduces the required amount of indentation.
+  EnforcedStyle: compact
+Style/EmptyElse:
+  Description: Enforce against empty else clauses, but allow `nil` for clarity.
+  EnforcedStyle: empty
+Style/FormatString:
+  Description: Following the main puppet project's style, prefer the % format format.
+  EnforcedStyle: percent
+Style/FormatStringToken:
+  Description: Following the main puppet project's style, prefer the simpler template
+    tokens over annotated ones.
+  EnforcedStyle: template
+Style/Lambda:
+  Description: Prefer the keyword for easier discoverability.
+  EnforcedStyle: literal
+Style/RegexpLiteral:
+  Description: Community preference. See https://github.com/voxpupuli/modulesync_config/issues/168
+  EnforcedStyle: percent_r
+Style/TernaryParentheses:
+  Description: Checks for use of parentheses around ternary conditions. Enforce parentheses
+    on complex expressions for better readability, but seriously consider breaking
+    it up.
+  EnforcedStyle: require_parentheses_when_complex
+Style/TrailingCommaInArguments:
+  Description: Prefer always trailing comma on multiline argument lists. This makes
+    diffs, and re-ordering nicer.
+  EnforcedStyleForMultiline: comma
+Style/SymbolArray:
+  Description: Using percent style obscures symbolic intent of array's contents.
+  EnforcedStyle: brackets
+inherit_from: ".rubocop_todo.yml"
+Style/CollectionMethods:
+  Enabled: true
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+Style/StringMethods:
+  Enabled: true
+Layout/EndOfLine:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/SymbolProc:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,25 @@
+---
+sudo: false
+dist: trusty
+language: ruby
+cache: bundler
+before_install:
+  - bundle -v
+  - rm -f Gemfile.lock
+  - gem update --system
+  - gem --version
+  - bundle -v
+script:
+  - 'bundle exec $CHECK'
+rvm:
+  - 2.4.1
+matrix:
+  fast_finish: true
+  include:
+    - env: CHECK='rubocop'
+    - env: CHECK='rspec spec'
+branches:
+  only:
+    - master
+    - /^v\d/
+    - release

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Change log
+
+All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
+
+## [0.1.0](https://github.com/puppetlabs/pdksync/tree/0.1.0) (2018-05-23)
+
+[Full Changelog](https://github.com/puppetlabs/pdksync/compare/73bf282b297781bc26562bfb51b91b4f7b1632d1...0.1.0)
+
+### Added
+
+- Add function to automatically fix validation issues [\#36](https://github.com/puppetlabs/pdksync/pull/36) ([HelenCampbell](https://github.com/HelenCampbell))
+- \(MODULES-7158\) Add in a delete branch method for cleanup purposes [\#33](https://github.com/puppetlabs/pdksync/pull/33) ([david22swan](https://github.com/david22swan))
+- \(MODULES-7021\) - Write README for pdksync [\#28](https://github.com/puppetlabs/pdksync/pull/28) ([david22swan](https://github.com/david22swan))
+- \(MODULES-7121\) Addition of error handling inside functions [\#27](https://github.com/puppetlabs/pdksync/pull/27) ([HelenCampbell](https://github.com/HelenCampbell))
+- \(MODULES-7085\) Notation added through the module [\#26](https://github.com/puppetlabs/pdksync/pull/26) ([david22swan](https://github.com/david22swan))
+- \(MODULES-7005\) - Add a test for adding files and update test titles [\#25](https://github.com/puppetlabs/pdksync/pull/25) ([pmcmaw](https://github.com/pmcmaw))
+- \(MODULES-7092\) - Read in managed\_modules.yml list [\#23](https://github.com/puppetlabs/pdksync/pull/23) ([david22swan](https://github.com/david22swan))
+- \(MODULES-7007\) Added basic iteration to the module. [\#22](https://github.com/puppetlabs/pdksync/pull/22) ([david22swan](https://github.com/david22swan))
+- \(MODULES-7049\) - Introduce pdk version and template url [\#21](https://github.com/puppetlabs/pdksync/pull/21) ([pmcmaw](https://github.com/pmcmaw))
+- \(MODULES-7030\) - Introduce constants.rb [\#20](https://github.com/puppetlabs/pdksync/pull/20) ([david22swan](https://github.com/david22swan))
+- Addition of PR creation [\#10](https://github.com/puppetlabs/pdksync/pull/10) ([HelenCampbell](https://github.com/HelenCampbell))
+- Basic Functionality Added [\#5](https://github.com/puppetlabs/pdksync/pull/5) ([david22swan](https://github.com/david22swan))
+- Setup of Files [\#1](https://github.com/puppetlabs/pdksync/pull/1) ([david22swan](https://github.com/david22swan))
+
+### Fixed
+
+- Update travis and change ssh to https for git clone [\#51](https://github.com/puppetlabs/pdksync/pull/51) ([HelenCampbell](https://github.com/HelenCampbell))
+- Change push command to use git ruby [\#13](https://github.com/puppetlabs/pdksync/pull/13) ([HelenCampbell](https://github.com/HelenCampbell))
+- PDK Update fix [\#8](https://github.com/puppetlabs/pdksync/pull/8) ([david22swan](https://github.com/david22swan))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pdksync.gemspec
+gemspec
+
+gem 'github_changelog_generator', git: 'https://github.com/skywinder/github-changelog-generator', ref: 'master'

data/LICENSE

@@ -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 [yyyy] [name of copyright owner]
+
+   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,155 @@
+# Pdksync
+
+Table of Contents
+-----------------
+
+1. [Overview](#overview)
+2. [Usage](#usage)
+3. [How it works](#how-it-works)
+4. [Installing](#installing)
+5. [Workflow](#workflow)
+6. [Migrating from modulesync to pdksync](#migrating-from-modulesync-to-pdksync)
+7. [Contributing](#contributing)
+
+### Overview
+--------
+
+Pdksync is an efficient way to run a `pdk update` command against the various repositories that we manage — keeping them up-to-date with the changes made to PDK. It is a solution for converted modules that no longer run with modulesync.
+
+### Usage
+----------
+
+> Note: This tool creates a 'live' pull request against the master branch of the module it is running against — defined in `managed_modules.yml`. Before running this tool, ensure this file  reflects the modules you wish it to run against, and that `constants.rb` is up-to-date with the correct namespace your modules reside in.
+
+1. To use pdksync, clone the GitHub repo or install it as a gem. Set up the environment by exporting a GitHub token:
+```
+export GITHUB_TOKEN=<access_token>
+```
+2. Before the script will run, you need to install the gems:
+```
+bundle install --path .bundle/gems/
+```
+3. Once this is complete, call the built-in rake task to run the module:
+```
+bundle exec rake pdksync
+```
+
+### How it works
+------------
+
+Pdksync is a gem that works to clone, update, and push module repositories. It is activated from within the pdksync module.
+
+The gem takes in a file, `managed_modules.yml`, stored within the gem that lists all the repositories that need to be updated. It then clones them, one after another, so that a local copy exists. The update command is ran against this local copy, with the subsequent changes being added into a commit on a unique branch. It is then pushed back to the remote master — where the local copy was originally cloned. The commit is merged to the master via a pull request, causing the gem to begin to clone the next repository.
+
+### Workflow
+--------
+
+It currently runs without additional arguments. To alter how it runs, make alterations to either the `constants.rb` or `managed_modules.yml`.
+
+### Managed modules
+----------
+
+This module runs through a pre-set array of modules, with this array set within the `managed_modules.yml` file. This file makes use of a simple `yaml` style format to set out the different module names, for example:
+
+```
+---
+- puppetlabs-motd
+- puppetlabs-stdlib
+- puppetlabs-mysql
+```
+To add a module, add it to the list. To remove a module, remove it from the list.
+
+### Migrating from modulesync to pdksync
+--------
+
+If your modules are currently managed by modulesync, and you want to use PDK and keep your modules up-to-date, read the following.
+
+#### Terminology
+- `pdk convert` - A command to convert your module, for example, to make it compatible with the PDK.
+- `convert_report.txt` - A report that shows the changes PDK will make to your module when `pdk convert` is ran.
+- `pdk update` - A command to consume any changes that have been made to the pdk-template used to convert the module.
+- `update_report.txt` - A report that shows the changes PDK will make to your module when `pdk update` is ran.
+- `pdk validate` - A command to run basic validation checks on your module.
+- `pdk test unit` - A command to run all available unit tests on your module.
+- `.sync.yml` - A file that lists all of of your module customizations — and will require  work before module conversion.
+
+##### Prerequisites
+* Unit tests are in a good state — with no failures. Check by running `pdk test unit`.
+* The module is in good shape. Check by running `pdk validate`.
+
+When you're confident everything is in good shape, you can start converting your module to make it compatible with PDK.
+
+##### Getting started
+
+1) Run `pdk convert --noop`. This will output to the console a high level overview of the changes that PDK is planning to make to your files.
+
+> Note: For an in-depth diff, see the convert_report.txt that is output in the module root directory.
+
+2) Make changes to your .sync.yml. State any configuration that the custom [pdk-templates](https://github.com/puppetlabs/pdk-templates) plan to remove.
+
+Useful commands via the .sync.yml:
+
+- Add additional gem dependencies:
+```
+Gemfile:
+  required:
+    ':system_tests':
+      - gem 'octokit'
+        platforms: ruby
+```
+- Make changes to your travis configuration:
+```
+.travis.yml:
+  branches:
+    - release
+```
+- Delete files that you don't want to exist in the repo:
+```
+.gitlab-ci.yml:
+  delete: true
+```
+- Unmanage files that you don't want to be managed:
+```
+.gitlab-ci.yml:
+  unmanaged: true
+```
+> Note: It is unlikely your module will work out of the box.
+
+3) When you are finished customizing your .sync.yml file, run `pdk convert --noop` and confirm the changes that PDK will make when you convert. Changes can be found in the `convert_report.txt`
+
+4) Run `pdk convert` to convert. You will be prompted to pass in Y/N — type Y and all your changes will be applied.
+
+> Note: If you have any concerns it is not too late — type N.
+
+5) Run your unit tests to confirm that nothing has broken. If there are breakages, you might need to require a library or include a missing gem — address this issue before you continue.
+
+6) Run `pdk validate` to ensure there are no failures.
+
+7) Commit the changes that the `pdk convert` has made and create your pull request.
+
+8) Remove your module from being managed via `modulesync`, and start using `pdksync` going forward — no more manually creating pull requests.
+
+For more information on keeping your module up to date with the PDK check out [Helens blog post](https://puppet.com/blog/guide-converting-module-pdk).
+
+### Compatibility
+----------
+
+This tool has been developed and tested on OSX and Linux. **It currently does not run on Windows.**
+
+### Contributing
+--------
+
+1. Fork the repo
+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,41 @@
+require_relative 'lib/pdksync'
+require 'github_changelog_generator/task'
+
+
+desc 'Run pdk update'
+task :pdksync do
+  PdkSync::run_pdksync
+  puts "The script has run."
+end
+
+desc 'Run pdksync cleanup'
+task :pdksync_cleanup do
+  PdkSync::clean_branches
+  puts "The script has run."
+end
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'puppetlabs'
+  config.project = 'pdksync'
+  # config.since_tag = '1.1.1'
+  config.future_release = '0.1.0'
+  config.exclude_labels = ['maintenance']
+  config.header = "# Change log\n\nAll notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org)."
+  config.add_pr_wo_labels = true
+  config.issues = false
+  config.merge_prefix = "### UNCATEGORIZED PRS; GO LABEL THEM"
+  config.configure_sections = {
+    "Changed" => {
+      "prefix" => "### Changed",
+      "labels" => ["backwards-incompatible"],
+    },
+    "Added" => {
+      "prefix" => "### Added",
+      "labels" => ["feature", "enhancement"],
+    },
+    "Fixed" => {
+      "prefix" => "### Fixed",
+      "labels" => ["bugfix"],
+    },
+  }
+end

data/lib/pdksync.rb

@@ -0,0 +1,322 @@
+# !/usr/bin/env ruby
+require 'git'
+require 'open3'
+require 'fileutils'
+require 'rake'
+require 'pdk'
+require 'octokit'
+require 'pdksync/constants'
+require 'json'
+require 'yaml'
+
+# @summary
+#   This module set's out and controls the pdksync process
+# @param [String] @access_token
+#   The token used to access github, must be exported locally.
+# @param [String] @namspace
+#   The namespace of the repositories we are updating.
+# @param [String] @pdksync_dir
+#   The local directory the repositories are to be copied to.
+# @param [String] @push_file_destination
+#   The remote that the pull requests are to be made against.
+# @param [String] @create_pr_against
+#   The branch the the pull requests are to be made against.
+# @param [String] @managed_modules
+#   The file that the array of managed modules is to be retrieved from.
+module PdkSync
+  include Constants
+  @access_token = Constants::ACCESS_TOKEN
+  @namespace = Constants::NAMESPACE
+  @pdksync_dir = Constants::PDKSYNC_DIR
+  @push_file_destination = Constants::PUSH_FILE_DESTINATION
+  @create_pr_against = Constants::CREATE_PR_AGAINST
+  @managed_modules = Constants::MANAGED_MODULES
+
+  # @summary
+  #   When a new instance of this module is called, this method will be run in order to start the pdksync process.
+  def self.run_pdksync
+    puts 'Beginning pdksync run'
+    create_filespace
+    @client = setup_client
+    @module_names = return_modules
+    # The current directory is saved for cleanup purposes
+    @main_path = Dir.pwd
+
+    # Run an iterative loop for each @module_name
+    @module_names.each do |module_name|
+      puts '*************************************'
+      puts "Syncing #{module_name}"
+      sync(module_name, @client)
+      # Cleanup used to ensure that the current directory is reset after each run.
+      Dir.chdir(@main_path) unless Dir.pwd == @main_path
+    end
+  end
+
+  # @summary
+  #   This method when called will create a directory identified by the set global variable '@pdksync_dir', on the condition that it does not already exist.
+  def self.create_filespace
+    FileUtils.mkdir @pdksync_dir unless Dir.exist?(@pdksync_dir)
+  end
+
+  # @summary
+  #   This method when called will create and return an octokit client with access to the upstream git repositories.
+  # @return [Octokit::Client] client
+  #   The octokit client that has been created.
+  def self.setup_client
+    client = Octokit::Client.new(access_token: @access_token.to_s)
+    client.user.login
+    puts 'Client login has been successful.'
+    client
+  rescue ArgumentError
+    raise "Access Token not set up correctly - Use export 'GITHUB_TOKEN=<put your token here>' to set it."
+  end
+
+  # @summary
+  #   This method when called will access a file set by the global variable '@managed_modules' and retrieve the information within as an array.
+  # @return [Array]
+  #   An array of different module names.
+  def self.return_modules
+    YAML.safe_load(File.open(@managed_modules))
+  end
+
+  # @summary
+  #   This method when called will take in a module name and an octokit client and use them to run the pdksync process on the given module.
+  #   If @git_repo is not set the clone will have failed, in which case we avoid further action. If the pdk update fails it will move to the
+  #   next module.
+  # @param [String] module_name
+  #   The name of the module to be put through the process
+  # @param [Octokit::Client] client
+  #   The client used to access github.
+  def self.sync(module_name, client)
+    @repo_name = "#{@namespace}/#{module_name}"
+    @output_path = "#{@pdksync_dir}/#{module_name}"
+    clean_env(@output_path) if Dir.exist?(@output_path)
+    @git_repo = clone_directory(@namespace, module_name, @output_path)
+
+    return if @git_repo.nil?
+    return unless pdk_update(@output_path) == 0 # rubocop:disable Style/NumericPredicate
+
+    @template_ref = return_template_ref
+    checkout_branch(@git_repo, @template_ref)
+    @pdk_version = return_pdk_version
+    add_staged_files(@git_repo)
+    commit_staged_files(@git_repo, @template_ref)
+    push_staged_files(@git_repo, @template_ref, @repo_name)
+    create_pr(client, @repo_name, @template_ref, @pdk_version)
+  end
+
+  # @summary
+  #   This method when called will call the delete function against the given repository if it exists.
+  # @param [String] output_path
+  #   The repository that is to be deleted.
+  def self.clean_env(output_path)
+    puts 'Cleaning your environment.'
+    # If a local copy already exists it is removed
+    FileUtils.rm_rf(output_path)
+  end
+
+  # @summary
+  #   This method when called will clone a given repository into a local location that has also been set.
+  # @param [String] namespace
+  #   The namespace the repository is located in.
+  # @param [String] module_name
+  #   The name of the repository.
+  # @param [String] output_path
+  #   The location the repository is to be cloned to.
+  # @return [Git::Base]
+  #   A git object representing the local repository.
+  def self.clone_directory(namespace, module_name, output_path)
+    puts "Cloning #{module_name} to #{output_path}."
+    Git.clone("https://github.com/#{namespace}/#{module_name}.git", output_path.to_s) # is returned
+  rescue Git::GitExecuteError
+    puts "(FAILURE) Cloning #{module_name} has failed - check the module name and namespace are correct."
+  end
+
+  # @summary
+  #   This method when called will run the 'pdk convert' command at the given location, with an error message being thrown if it is not successful.
+  # @param [String] output_path
+  #   The location that the command is to be run from.
+  # @return [Integer]
+  #   The status code of the pdk converty run.
+  def self.pdk_convert(output_path)
+    Dir.chdir(output_path) unless Dir.pwd == output_path
+    _stdout, stderr, status = Open3.capture3('pdk convert --force --template-url https://github.com/puppetlabs/pdk-templates')
+    if status != 0
+      puts "(FAILURE) Unable to run `pdk convert`: #{stderr}"
+    else
+      puts 'PDK convert has run.'
+    end
+    status
+  end
+
+  # @summary
+  #   This method when called will run the 'pdk update --force' command at the given location, with an error message being thrown if it is not successful.
+  # @param [String] output_path
+  #   The location that the command is to be run from.
+  # @return [Integer]
+  #   The status code of the pdk update run.
+  def self.pdk_update(output_path)
+    # Runs the pdk update command
+    Dir.chdir(output_path) unless Dir.pwd == output_path
+    stdout, stderr, status = Open3.capture3('pdk update --force')
+    if status != 0
+      puts "(FAILURE) Unable to run `pdk update`: #{stderr}"
+    else
+      puts 'PDK update has run.'
+    end
+    return status unless status == 0 && stdout.include?('No changes required.') # rubocop:disable Style/NumericPredicate
+    puts 'No commits since last run.'
+  end
+
+  # @summary
+  #   This method when called will run the 'pdk validate -a' command at the given location, with an error message being thrown if it is not successful.
+  # @param [String] output_path
+  #   The location that the command is to be run from.
+  # @return [Integer]
+  #   The status code of the pdk validate run.
+  def self.validate_autofix
+    # Runs the pdk validate command
+    _stdout, stderr, status = Open3.capture3('pdk validate -a')
+    if status != 0
+      puts "(FAILURE) Something went wrong with the validate: #{stderr}"
+    else
+      puts 'Validate has run successfully.'
+    end
+    status
+  end
+
+  # @summary
+  #   This method when called will retrieve the template ref of the current module, i.e. the one that was navigated into in the 'pdk_update' method.
+  # @param [String] metadata_file
+  #   An optional input that can be used to set the location of the metadata file.
+  # @return [String]
+  #   A string value that represents the current pdk template.
+  def self.return_template_ref(metadata_file = 'metadata.json')
+    file = File.read(metadata_file)
+    data_hash = JSON.parse(file)
+    data_hash['template-ref']
+  end
+
+  # @summary
+  #   This method when called will checkout a new local branch of the given repository.
+  # @param [Git::Base] git_repo
+  #   A git object representing the local repository to be branched.
+  # @param [String] template_ref
+  #   The unique template_ref that is used as part of the branch name.
+  def self.checkout_branch(git_repo, template_ref)
+    puts "Creating the following branch: pdksync_#{template_ref}."
+    git_repo.branch("pdksync_#{template_ref}".to_s).checkout
+  end
+
+  # @summary
+  #   This method when called will retrieve the pdk_version of the current module, i.e. the one that was navigated into in the 'pdk_update' method.
+  # @param [String] metadata_file
+  #   An optional input that can be used to set the location of the metadata file.
+  # @return [String]
+  #   A string value that represents the current pdk version.
+  def self.return_pdk_version(metadata_file = 'metadata.json')
+    file = File.read(metadata_file)
+    data_hash = JSON.parse(file)
+    data_hash['pdk-version']
+  end
+
+  # @summary
+  #   This method when called will stage all changed files within the given repository, conditional on them being managed via the pdk.
+  # @param [Git::Base] git_repo
+  #   A git object representing the local repository to be staged.
+  def self.add_staged_files(git_repo)
+    git_repo.add(all: true)
+    puts 'All files have been staged.'
+  end
+
+  # @summary
+  #   This method when called will create a commit containing all currently staged files, with the name of the commit containing the template ref as a unique identifier.
+  # @param [Git::Base] git_repo
+  #   A git object representing the local repository against which the commit is to be made.
+  # @param [String] template_ref
+  #   The unique template_ref that is used as part of the commit name.
+  def self.commit_staged_files(git_repo, template_ref)
+    git_repo.commit("pdksync_#{template_ref}")
+    puts "Creating the following commit: pdksync_#{template_ref}."
+  end
+
+  # @summary
+  #   This method when called will push the given local commit to local repository's origin.
+  # @param [Git::Base] git_repo
+  #   A git object representing the local repository againt which the push is to be made.
+  # @param [String] template_ref
+  #   The unique reference that that represents the template the update has ran against.
+  # @param [String] repo_name
+  #   The name of the repository on which the commit is to be made.
+  def self.push_staged_files(git_repo, template_ref, repo_name)
+    git_repo.push(@push_file_destination, "pdksync_#{template_ref}")
+    puts 'All staged files have been pushed to the repo, bon voyage!'
+  rescue StandardError
+    puts "(FAILURE) Pushing to #{@push_file_destination} for #{repo_name} has failed."
+  end
+
+  # @summary
+  #   This method when called will create a pr on the given repository that will create a pr to merge the given commit into the master with the pdk version as an identifier.
+  # @param [Octokit::Client] client
+  #   The octokit client used to gain access to and manipulate the repository.
+  # @param [String] repo_name
+  #   The name of the repository on which the commit is to be made.
+  # @param [String] template_ref
+  #   The unique reference that that represents the template the update has ran against.
+  # @param [String] pdk_version
+  #   The current version of the pdk on which the update is run.
+  def self.create_pr(client, repo_name, template_ref, pdk_version)
+    pr = client.create_pull_request(repo_name, @create_pr_against,
+                                    "pdksync_#{template_ref}".to_s,
+                                    "pdksync - Update using #{pdk_version}",
+                                    "pdk version: `#{pdk_version}` \n pdk template ref: `#{template_ref}`")
+    puts 'The PR has been created.'
+    pr
+  rescue StandardError
+    puts "(FAILURE) PR creation for #{repo_name} has failed."
+  end
+
+  # @summary
+  #   This method when called will retrieve a list of module names and then proceed to iterate
+  #     through them, removing any branch that contains the word 'pdksync'.
+  def self.clean_branches
+    puts 'Beginning pdksync cleanup run'
+    @client = setup_client
+    @module_names = return_modules
+
+    @module_names.each do |module_name|
+      puts '*************************************'
+      puts "Cleaning #{module_name}"
+      @repo_name = "#{@namespace}/#{module_name}"
+      retrieve_branches(@client, @repo_name).each do |branch|
+        delete_branch(@client, @repo_name, branch.name) if branch.name.include? 'pdksync'
+      end
+    end
+  end
+
+  # @summary
+  #   This method when called will retrieve any and all branches from the given repository.
+  # @param [Octokit::Client] client
+  #   The octokit client used to gain access to and manipulate the repository.
+  # @param [String] repo_name
+  #   The name of the repository from which the branches are to be retrieved.
+  # @return [Array]
+  #   An array containing all existing branches
+  def self.retrieve_branches(client, repo_name)
+    puts "Retrieving branches from #{repo_name}"
+    client.branches(repo_name)
+  end
+
+  # @summary
+  #   This method when called will delete any preexisting branch on the given repository that matches the given name.
+  # @param [Octokit::Client] client
+  #   The octokit client used to gain access to and manipulate the repository.
+  # @param [String] repo_name
+  #   The name of the repository from which the branch is to be deleted.
+  # @param [String] branch_name
+  #   The name of the branch that is to be deleted.
+  def self.delete_branch(client, repo_name, branch_name)
+    puts "Removing '#{branch_name}' from '#{repo_name}'"
+    client.delete_branch(repo_name, branch_name)
+  end
+end

data/lib/pdksync/constants.rb

@@ -0,0 +1,12 @@
+# @summary
+#   A module used to contain a set of variables that are expected to remain constant across all iterations of the main pdksync module.
+module PdkSync # rubocop:disable Style/ClassAndModuleChildren
+  module Constants
+    ACCESS_TOKEN = ENV['GITHUB_TOKEN'].freeze
+    NAMESPACE = 'puppetlabs'.freeze
+    PDKSYNC_DIR = 'modules_pdksync'.freeze
+    PUSH_FILE_DESTINATION = 'origin'.freeze
+    CREATE_PR_AGAINST = 'master'.freeze
+    MANAGED_MODULES = 'managed_modules.yml'.freeze
+  end
+end

data/managed_modules.yml

@@ -0,0 +1,30 @@
+---
+- puppetlabs-accounts
+- puppetlabs-apache
+- puppetlabs-apt
+- puppetlabs-firewall
+- puppetlabs-haproxy
+- puppetlabs-ibm_installation_manager
+- puppetlabs-java
+- puppetlabs-mysql
+- puppetlabs-ntp
+- puppetlabs-postgresql
+# - puppetlabs-satellite_pe_tools
+- puppetlabs-tagmail
+- puppetlabs-tomcat
+- puppetlabs-translate
+# - puppetlabs-vcsrepo
+- puppetlabs-websphere_application_server
+- puppetlabs-bootstrap
+- puppetlabs-concat
+- puppetlabs-exec
+- puppetlabs-facter_task
+- puppetlabs-hocon
+- puppetlabs-inifile
+# - puppetlabs-java_ks
+- puppetlabs-motd
+- puppetlabs-package
+- puppetlabs-puppet_conf
+- puppetlabs-resource
+- puppetlabs-service
+- puppetlabs-stdlib

data/pdksync.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'pdksync'
+  spec.version               = '0.1.0'
+  spec.authors               = ['Puppet']
+  spec.email                 = ['']
+  spec.summary               = 'Puppet Module PDK Synchronizer'
+  spec.description           = 'Utility to synchronize common files across puppet modules using PDK Update.'
+  spec.homepage              = 'http://github.com/puppetlabs/pdksync'
+  spec.license               = 'Apache-2.0'
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop', '~> 0.50.0'
+  spec.add_development_dependency 'octokit'
+  spec.add_development_dependency 'pry'
+
+  spec.add_runtime_dependency 'git', '~>1.3'
+  spec.add_runtime_dependency 'pdk', '>= 1.4.1'
+end

data/spec/lib/pdksync_spec.rb

@@ -0,0 +1,68 @@
+require_relative '../../lib/pdksync'
+require 'git'
+require 'fileutils'
+require 'octokit'
+
+describe PdkSync do
+  before(:all) do
+    @timestamp = Time.now.to_i
+    @namespace = 'puppetlabs'
+    @pdksync_dir = './modules_pdksync'
+    @module_name = 'puppetlabs-testing'
+    @output_path = "#{@pdksync_dir}/#{@module_name}"
+    @access_token = ENV['GITHUB_TOKEN']
+    @repo_name = "#{@namespace}/#{@module_name}"
+  end
+
+  context 'env' do
+    it 'has a filespace' do
+      FileUtils.rm_rf(@pdksync_dir)
+      PdkSync.create_filespace
+      expect(Dir.exist?(@pdksync_dir)).to be(true)
+    end
+
+    it 'has cloned the repo' do
+      PdkSync.clone_directory(@namespace, @module_name, @output_path)
+      expect(Dir.exist?(@output_path)).to be(true)
+    end
+  end
+
+  context 'run' do
+    before(:all) do
+      @git_repo = Git.open(@output_path)
+    end
+
+    it 'has created a branch' do
+      PdkSync.checkout_branch(@git_repo, @timestamp)
+      expect(@git_repo.current_branch).to include(@timestamp.to_s)
+    end
+
+    it 'has created a report' do
+      FileUtils.rm_rf('update_report.txt')
+      PdkSync.pdk_update(@output_path)
+      expect(File.exist?('update_report.txt')).to be(true)
+    end
+
+    it 'has staged files' do
+      PdkSync.add_staged_files(@git_repo)
+      result = Open3.capture3('git status')
+      expect(result).to include(%r{Changes to be committed})
+    end
+
+    it 'has committed files' do
+      pre_commit = @git_repo.log.last
+      PdkSync.commit_staged_files(@git_repo, @timestamp)
+      post_commit = @git_repo.log.last
+      expect(pre_commit).not_to eq(post_commit)
+    end
+  end
+  # # Test fails if ran from travis due to lack of proper credentials
+  # it 'The committed files should be pushed and the PR created', unless: @access_token == '' do
+  #   @client = PdkSync.setup_client
+  #   PdkSync.push_staged_files(@git_repo, @timestamp, @repo_name)
+  #   pr = PdkSync.create_pr(@client, @repo_name, @timestamp, @timstamp)
+  #   expect(pr.title).to eq("pdksync - pdksync_#{@timestamp}")
+  #   #Branch is now cleaned
+  #   PdkSync.delete_branch(@client, @repo_name, "pdksync_#{@timestamp}".to_s)
+  # end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: pdksync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Puppet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+description: Utility to synchronize common files across puppet modules using PDK Update.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pdksync.rb
+- lib/pdksync/constants.rb
+- managed_modules.yml
+- pdksync.gemspec
+- spec/lib/pdksync_spec.rb
+homepage: http://github.com/puppetlabs/pdksync
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Puppet Module PDK Synchronizer
+test_files:
+- spec/lib/pdksync_spec.rb