ruby-pwsh 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45a4e8fcc1b0bf5eba64fc3798038898f082e1f2306523e197de6c801f61c872
-  data.tar.gz: 31817197b1a07056dd1f4e6d9296eec1ceb4a39380244a9d00aa937a4ac76aa6
+  metadata.gz: 461a867f01c932c2baaaee8211f32cec09921d1e1b8f706fc7abe9dba7489d7b
+  data.tar.gz: 9086a7408096976b332b8b1fe97771de8d86788d3ac2a87421493b89b9215311
 SHA512:
-  metadata.gz: 5fd66bd52888d7a52bc262d2f977f6100b723531ee283aff31aec7e95ab9b0605e3fce7dcb94e34d13de4b01d0236a56b49ca60e55148e7df4a7dfee63cd8f2d
-  data.tar.gz: 98668a759b733ddc17651011709c1070ae0b407afb84f4de356ec2b181d8353db0d5b57f1cdc64cf67039c994fb6811c679140a3177ba9e489ba72a3874032d0
+  metadata.gz: ed6bff68ed27bcb1db20103cf7105bea51776456073f457177c029251aa0c2c0b9d7aec1085f86141b1c88ce0c06da4e7cf5ac6a3375b7aca5684c06c575b2fb
+  data.tar.gz: 29a9c33098583b09e10ed5c18f706da954e5ce1d1b1f5fdf24ba086128da851d1e24e954ae9b0735abc3cd95d9bc4faaec61d327c78595fac04c50c9123b4d5c

data/.pmtignore

@@ -0,0 +1,19 @@
+.bundle
+.yardoc
+doc
+.git
+spec
+.gitattributes
+.gitignore
+.rspec
+.rspec_status
+.rubocop.yml
+.travis.yml
+CODEOWNERS
+CONTRIBUTING.md
+design-comms.png
+DESIGN.md
+Gemfile
+Gemfile.lock
+Rakefile
+ruby-pwsh.gemspec

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# 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.2.0](https://github.com/puppetlabs/ruby-pwsh/tree/0.2.0) (2019-11-25)
+
+[Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.1.0...0.2.0)
+
+### Added
+
+- \(FEAT\) Add quality of life utilities [\#11](https://github.com/puppetlabs/ruby-pwsh/pull/11) ([michaeltlombardi](https://github.com/michaeltlombardi))
+- \(FM-8422\) Make library releasable as a Puppet module [\#8](https://github.com/puppetlabs/ruby-pwsh/pull/8) ([michaeltlombardi](https://github.com/michaeltlombardi))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/CONTRIBUTING.md

@@ -0,0 +1,155 @@
+# Contributing to ruby-pwsh
+
+So you want to contribute to the ruby-pwsh gem: Great! Below are some instructions to get you started doing
+that very thing while setting expectations around code quality as well as a few tips for making the
+process as easy as possible.
+
+## Table of Contents
+
+1. [Getting Started](#getting-started)
+1. [Commit Checklist](#commit-checklist)
+1. [Submission](#submission)
+1. [More about commits](#more-about-commits)
+1. [Testing](#testing)
+    - [Running Tests](#running-tests)
+    - [Writing Tests](#writing-tests)
+1. [Get Help](#get-help)
+
+## Getting Started
+
+- Fork the module repository on GitHub and clone to your workspace
+- Make your changes!
+
+## Commit Checklist
+
+### The Basics
+
+- [x] my commit is a single logical unit of work
+- [x] I have checked for unnecessary whitespace with "git diff --check"
+- [x] my commit does not include commented out code or unneeded files
+
+### The Content
+
+- [x] my commit includes tests for the bug I fixed or feature I added
+- [x] my commit includes appropriate documentation changes if it is introducing a new feature or changing existing functionality
+- [x] my code passes existing test suites
+
+### The Commit Message
+
+- [x] the first line of my commit message includes:
+  - [x] an issue number (if applicable), e.g. "(GH-xxxx) This is the first line"
+  - [x] a short description (50 characters is the soft limit, excluding issue number(s))
+- [x] the body of my commit message:
+  - [x] is meaningful
+  - [x] uses the imperative, present tense: "change", not "changed" or "changes"
+  - [x] includes motivation for the change, and contrasts its implementation with the previous behavior
+
+## Submission
+
+### Pre-requisites
+
+- Make sure you have a [GitHub account](https://github.com/join)
+- [Create an issue](https://github.com/puppetlabs/ruby-pwsh/issues/new/choose), or [watch the issue](https://github.com/puppetlabs/ruby-pwsh/issues) you are patching for.
+
+### Push and PR
+
+- Push your changes to your fork
+- [Open a Pull Request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the repository in the puppetlabs organization
+
+## More about commits
+
+1.  Make separate commits for logically separate changes.
+
+    Please break your commits down into logically consistent units which include new or changed tests relevant to the rest of the change.
+    The goal of doing this is to make the diff easier to read for whoever is reviewing your code.
+    In general, the easier your diff is to read, the more likely someone will be happy to review it and get it into the code base.
+
+    If you are going to refactor a piece of code, please do so as a separate commit from your feature or bug fix changes.
+
+    We also really appreciate changes that include tests to make sure the bug is not re-introduced, and that the feature is not accidentally broken.
+
+    Describe the technical detail of the change(s).
+    If your description starts to get too long, that is a good sign that you probably need to split up your commit into more finely grained pieces.
+
+    Commits which plainly describe the things which help reviewers check the patch and future developers understand the code are much more likely to be merged in with a minimum of bike-shedding or requested changes.
+    Ideally, the commit message would include information, and be in a form suitable for inclusion in the release notes for the version of Puppet that includes them.
+
+    Please also check that you are not introducing any trailing whitespace or other "whitespace errors".
+    You can do this by running `git diff --check` on your changes before you commit.
+
+2.  Sending your patches
+
+    To submit your changes via a GitHub pull request, we _highly_ recommend that you have them on a topic branch, instead of directly on "master".
+    It makes things much easier to keep track of, especially if you decide to work on another thing before your first change is merged in.
+
+    GitHub has some pretty good [general documentation](http://help.github.com/) on using their site.
+    They also have documentation on [creating pull requests](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
+
+    In general, after pushing your topic branch up to your repository on GitHub, you can switch to the branch in the GitHub UI and click "Pull Request" towards the top of the page in order to open a pull request.
+
+3.  Update the related GitHub issue.
+
+    If there is a GitHub issue associated with the change you submitted, then you should update the issue to include the location of your branch, along with any other commentary you may wish to make.
+
+# Testing
+
+## Getting Started
+
+Our Puppet modules provide [`Gemfile`](./Gemfile)s, which can tell a Ruby package manager such as [bundler](http://bundler.io/) what Ruby packages,
+or Gems, are required to build, develop, and test this software.
+
+Please make sure you have [bundler installed](http://bundler.io/#getting-started) on your system, and then use it to
+install all dependencies needed for this project in the project root by running
+
+```shell
+# Unless you're doing a release, you don't need the puppet gem group
+% bundle install --path .bundle/gems --without puppet
+Fetching gem metadata from https://rubygems.org/........
+Fetching gem metadata from https://rubygems.org/..
+Using rake (10.1.0)
+Using builder (3.2.2)
+-- 8><-- many more --><8 --
+Your bundle is complete!
+Use `bundle show [gemname]` to see where a bundled gem is installed.
+```
+
+NOTE: some systems may require you to run this command with sudo.
+
+If you already have those gems installed, make sure they are up-to-date:
+
+```shell
+% bundle update
+```
+
+## Running Tests
+
+With all dependencies in place and up-to-date, run the tests:
+
+### Unit Tests
+
+```shell
+% bundle exec rake spec
+```
+
+This executes all the [rspec tests](https://rspec.info/) in the `spec` directory.
+
+## If you have commit access to the repository
+
+Even if you have commit access to the repository, you still need to go through the process above, and have someone else review and merge
+in your changes.
+The rule is that **all changes must be reviewed by a project developer that did not write the code to ensure that all changes go through a code review process.**
+
+The record of someone performing the merge is the record that they performed the code review.
+Again, this should be someone other than the author of the topic branch.
+
+## Get Help
+
+### On the web
+
+- [General GitHub documentation](http://help.github.com/)
+- [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+
+### On chat
+
+- Slack (slack.puppet.com) #forge-modules, #puppet-dev, #windows, #voxpupuli
+- IRC (freenode) #puppet-dev, #voxpupuli

data/Gemfile

@@ -22,6 +22,10 @@ group :development do
   gem 'yard'
 end
 
+group :puppet do
+  gem 'pdk', '~> 1.0'
+end
+
 group :pry do
   gem 'fuubar'
 

data/Rakefile

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require 'rubocop/rake_task'
+require 'fileutils'
 require 'github_changelog_generator/task'
+require 'open3'
 require 'pwsh/version'
 require 'rspec/core/rake_task'
 require 'yard'
@@ -10,8 +12,8 @@ GitHubChangelogGenerator::RakeTask.new :changelog do |config|
   config.user = 'puppetlabs'
   config.project = 'ruby-pwsh'
   config.future_release = Pwsh::VERSION
-  config.since_tag = '0.0.1'
-  config.exclude_labels = ['maintenance']
+  config.since_tag = '0.1.0'
+  config.exclude_labels = ['maint']
   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
@@ -42,3 +44,59 @@ task default: :spec
 
 YARD::Rake::YardocTask.new do |t|
 end
+
+# Executes a command locally.
+#
+# @param command [String] command to execute.
+# @return [Object] the standard out stream.
+def run_local_command(command)
+  stdout, stderr, status = Open3.capture3(command)
+  error_message = "Attempted to run\ncommand:'#{command}'\nstdout:#{stdout}\nstderr:#{stderr}"
+  raise error_message unless status.to_i.zero?
+
+  stdout
+end
+
+# Build the gem
+desc 'Build the gem'
+task :build do
+  gemspec_path = File.join(Dir.pwd, 'ruby-pwsh.gemspec')
+  # Delete the puppet-specific code if it exists
+  FileUtils.rm_r('lib/puppet') if File.exist?('lib/puppet')
+  run_local_command("bundle exec gem build '#{gemspec_path}'")
+end
+
+# Tag the repo with a version in preparation for the release
+#
+# @param :version [String] a semantic version to tag the code with
+# @param :sha [String] the sha at which to apply the version tag
+desc 'Tag the repo with a version in preparation for release'
+task :tag, [:version, :sha] do |_task, args|
+  raise "Invalid version #{args[:version]} - must be like '1.2.3'" unless args[:version] =~ /^\d+\.\d+\.\d+$/
+
+  run_local_command('git fetch upstream')
+  run_local_command("git tag -a version -m #{args[:version]} #{args[:sha]}")
+  run_local_command('git push upstream --tags')
+end
+
+# Push the built gem to RubyGems
+#
+# @param :path [String] optional, the full or relative path to the built gem to be pushed
+desc 'Push to RubyGems'
+task :push, [:path] do |_task, args|
+  raise 'No discoverable gem for pushing' if Dir.glob("ruby-pwsh*\.gem").empty? && args[:path].nil?
+  raise "No file found at specified path: '#{args[:path]}'" unless File.exist?(args[:path])
+
+  path = args[:path] || File.join(Dir.pwd, Dir.glob("ruby-pwsh*\.gem")[0])
+  run_local_command("bundle exec gem push #{path}")
+end
+
+desc 'Build for Puppet'
+task :build_module do
+  actual_readme_content = File.read('README.md')
+  FileUtils.copy_file('pwshlib.md', 'README.md')
+  # Build
+  run_local_command('pdk build --force')
+  # Cleanup
+  File.open('README.md', 'wb') { |file| file.write(actual_readme_content) }
+end

data/lib/pwsh/util.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Manage PowerShell and Windows PowerShell via ruby
 module Pwsh
   # Various helper methods
   module Util
@@ -29,6 +30,94 @@ module Pwsh
 
       invalid_paths
     end
+
+    # Return a string converted to snake_case
+    #
+    # @return [String] snake_cased string
+    def snake_case(string)
+      # Implementation copied from: https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/snakecase.rb
+      # gsub(/::/, '/').
+      string.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .tr('-', '_')
+            .gsub(/\s/, '_')
+            .gsub(/__+/, '_')
+            .downcase
+    end
+
+    # Iterate through a hashes keys, snake_casing them
+    #
+    # @return [Hash] Hash with all keys snake_cased
+    def snake_case_hash_keys(hash)
+      modified_hash = {}
+      hash.each do |key, value|
+        value = snake_case_hash_keys(value) if value.is_a?(Hash)
+        modified_hash[snake_case(key.to_s).to_sym] = value
+      end
+      modified_hash
+    end
+
+    # Return a string converted to PascalCase
+    #
+    # @return [String] PascalCased string
+    def pascal_case(string)
+      # Break word boundaries to snake case first
+      snake_case(string).split('_').collect(&:capitalize).join
+    end
+
+    # Iterate through a hashes keys, PascalCasing them
+    #
+    # @return [Hash] Hash with all keys PascalCased
+    def pascal_case_hash_keys(hash)
+      modified_hash = {}
+      hash.each do |key, value|
+        value = pascal_case_hash_keys(value) if value.is_a?(Hash)
+        modified_hash[pascal_case(key.to_s).to_sym] = value
+      end
+      modified_hash
+    end
+
+    # Ensure that quotes inside a passed string will continue to be passed
+    #
+    # @return [String] the string with quotes escaped
+    def escape_quotes(text)
+      text.gsub("'", "''")
+    end
+
+    # Convert a ruby value into a string to be passed along to PowerShell for interpolation in a command
+    # Handles:
+    # - Strings
+    # - Numbers
+    # - Booleans
+    # - Symbols
+    # - Arrays
+    # - Hashes
+    #
+    # @return [String] representation of the value for interpolation
+    def format_powershell_value(object)
+      if %i[true false].include?(object) || %w[trueclass falseclass].include?(object.class.name.downcase) # rubocop:disable Lint/BooleanSymbol
+        "$#{object}"
+      elsif object.class.name == 'Symbol' || object.class.ancestors.include?(Numeric)
+        object.to_s
+      elsif object.class.name == 'String'
+        "'#{escape_quotes(object)}'"
+      elsif object.class.name == 'Array'
+        '@(' + object.collect { |item| format_powershell_value(item) }.join(', ') + ')'
+      elsif object.class.name == 'Hash'
+        '@{' + object.collect { |k, v| format_powershell_value(k) + ' = ' + format_powershell_value(v) }.join('; ') + '}'
+      else
+        raise "unsupported type #{object.class} of value '#{object}'"
+      end
+    end
+
+    # Return the representative string of a PowerShell hash for a custom object property to be used in selecting or filtering.
+    # The script block for the expression must be passed as the string you want interpolated into the hash; this method does
+    # not do any of the additional work of interpolation for you as the type sits inside a code block inside a hash.
+    #
+    # @return [String] representation of a PowerShell hash with the keys 'Name' and 'Expression'
+    def custom_powershell_property(name, expression)
+      "@{Name = '#{name}'; Expression = {#{expression}}}"
+    end
   end
 end
 

data/lib/pwsh/version.rb

@@ -2,5 +2,5 @@
 
 module Pwsh
   # The version of the ruby-pwsh gem
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/metadata.json

@@ -0,0 +1,85 @@
+{
+  "name": "puppetlabs-pwshlib",
+  "version": "0.2.0",
+  "author": "puppetlabs",
+  "summary": "Provide library code for interoperating with PowerShell.",
+  "license": "MIT",
+  "source": "https://github.com/puppetlabs/ruby-pwsh",
+  "project_page": "https://github.com/puppetlabs/ruby-pwsh/pwshlib.md",
+  "issues_url": "https://github.com/puppetlabs/ruby-pwsh/issues",
+  "dependencies": [
+
+  ],
+  "operatingsystem_support": [
+    {
+      "operatingsystem": "CentOS",
+      "operatingsystemrelease": [
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "OracleLinux",
+      "operatingsystemrelease": [
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "RedHat",
+      "operatingsystemrelease": [
+        "8"
+      ]
+    },
+    {
+      "operatingsystem": "Scientific",
+      "operatingsystemrelease": [
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "Debian",
+      "operatingsystemrelease": [
+        "9"
+      ]
+    },
+    {
+      "operatingsystem": "Ubuntu",
+      "operatingsystemrelease": [
+        "18.04"
+      ]
+    },
+    {
+      "operatingsystem": "windows",
+      "operatingsystemrelease": [
+        "2019",
+        "10"
+      ]
+    },
+    {
+      "operatingsystem": "SLES",
+      "operatingsystemrelease": [
+        "15"
+      ]
+    },
+    {
+      "operatingsystem": "Darwin",
+      "operatingsystemrelease": [
+        "16"
+      ]
+    },
+    {
+      "operatingsystem": "Fedora",
+      "operatingsystemrelease": [
+        "29"
+      ]
+    }
+  ],
+  "requirements": [
+    {
+      "name": "puppet",
+      "version_requirement": ">= 4.10.0 < 7.0.0"
+    }
+  ],
+  "pdk-version": "1.13.0",
+  "template-url": "pdk-default#1.13.0",
+  "template-ref": "1.13.0-0-g66e1443"
+}

data/pwshlib.md

@@ -0,0 +1,90 @@
+# pwshlib
+
+This module enables you to leverage the `ruby-pwsh` gem to execute PowerShell from within your Puppet providers without having to instantiate and tear down a PowerShell process for each command called.
+It supports Windows PowerShell as well as PowerShell Core - if you're running **PowerShell v3+**, this gem supports you.
+
+The `Manager` class enables you to execute and interoperate with PowerShell from within ruby, leveraging the strengths of both languages as needed.
+
+## Prerequisites
+
+Include `puppetlabs-pwshlib` as a dependency in your module and you can leverage it in your providers by using a requires statement, such as in this example:
+
+```ruby
+require 'puppet/resource_api/simple_provider'
+begin
+  require 'ruby-pwsh'
+rescue LoadError
+  raise 'Could not load the "ruby-pwsh" library; is the dependency module puppetlabs-pwshlib installed in this environment?'
+end
+
+# Implementation for the foo type using the Resource API.
+class Puppet::Provider::Foo::Foo < Puppet::ResourceApi::SimpleProvider
+  def get(context)
+    context.debug("PowerShell Path: #{Pwsh::Manager.powershell_path}")
+    context.debug('Returning pre-canned example data')
+    [
+      {
+        name: 'foo',
+        ensure: 'present',
+      },
+      {
+        name: 'bar',
+        ensure: 'present',
+      },
+    ]
+  end
+
+  def create(context, name, should)
+    context.notice("Creating '#{name}' with #{should.inspect}")
+  end
+
+  def update(context, name, should)
+    context.notice("Updating '#{name}' with #{should.inspect}")
+  end
+
+  def delete(context, name)
+    context.notice("Deleting '#{name}'")
+  end
+end
+```
+
+Aside from adding it as a dependency to your module metadata, you will probably also want to include it in your `.fixtures.yml` file:
+
+```yaml
+fixtures:
+  forge_modules:
+    pwshlib: "puppetlabs/pwshlib"
+```
+
+## Using the Library
+
+Instantiating the manager can be done using some defaults:
+
+```ruby
+# Instantiate the manager for Windows PowerShell, using the default path and arguments
+# Note that this takes a few seconds to instantiate.
+posh = Pwsh::Manager.instance(Pwsh::Manager.powershell_path, Pwsh::Manager.powershell_args)
+# If you try to create another manager with the same arguments it will reuse the existing one.
+ps = Pwsh::Manager.instance(Pwsh::Manager.powershell_path, Pwsh::Manager.powershell_args)
+# Note that this time the return is very fast.
+# We can also use the defaults for PowerShell Core, though these only work if PowerShell is
+# installed to the default paths - if it is installed anywhere else, you'll need to specify
+# the full path to the pwsh executable.
+pwsh = Pwsh::Manager.instance(Pwsh::Manager.pwsh_path, Pwsh::Manager.pwsh_args)
+```
+
+Execution can be done with relatively little additional work - pass the command string you want executed:
+
+```ruby
+# Instantiate the Manager:
+posh = Pwsh::Manager.instance(Pwsh::Manager.powershell_path, Pwsh::Manager.powershell_args)
+# Pretty print the output of `$PSVersionTable` to validate the version of PowerShell running
+# Note that the output is a hash with a few different keys, including stdout.
+Puppet.debug(posh.execute('$PSVersionTable'))
+# Lets reduce the noise a little and retrieve just the version number:
+# Note: We cast to a string because PSVersion is actually a Version object.
+Puppet.debug(posh.execute('[String]$PSVersionTable.PSVersion'))
+# We could store this output to a ruby variable if we wanted, for further use:
+ps_version = posh.execute('[String]$PSVersionTable.PSVersion')[:stdout].strip
+Puppet.debug("The PowerShell version of the currently running Manager is #{ps_version}")
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pwsh
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-25 00:00:00.000000000 Z
+date: 2019-11-26 00:00:00.000000000 Z
 dependencies: []
 description: PowerShell code manager for ruby.
 email:
@@ -19,10 +19,13 @@ extra_rdoc_files: []
 files:
 - ".gitattributes"
 - ".gitignore"
+- ".pmtignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODEOWNERS
+- CONTRIBUTING.md
 - DESIGN.md
 - Gemfile
 - LICENSE.txt
@@ -35,6 +38,8 @@ files:
 - lib/pwsh/windows_powershell.rb
 - lib/ruby-pwsh.rb
 - lib/templates/init.ps1
+- metadata.json
+- pwshlib.md
 - ruby-pwsh.gemspec
 homepage: https://github.com/puppetlabs/ruby-pwsh
 licenses: