puppet-function-updater 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43740352c17551ddd5440e4ece70ad04248b2ee9a3c64ad7a8cd13e2f6a2c8f1
+  data.tar.gz: c515002e42faadc8fee35f37a6a76805d2cc0d44ace7d9609e494cc4590c9360
+SHA512:
+  metadata.gz: a8fa785031af5cd3d22adaee5db4363bb8849ee541ef0c939cdb67d34e9715b266f83ddf708721ac4f3c23ccbdd84d999eba5c8daef97b0a326097fb26cdad2b
+  data.tar.gz: 642f1dedcb74988a68f6c872598ac9d18f55db968a328b4a8f4a7b58f00b9d0f9e69584605f767fcaf0f94fcfb2c107e2b6001a6e7c000fd65787fc4ab603bfe

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+v0.0.1
+  * Initial release

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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,37 @@
+# Puppet Function Updater
+
+Port legacy Puppet 3.x functions to the new function API automatically.
+
+Run this command with a space separated list of either function file paths, or
+directories containing functions. If omitted, it will default to porting all the
+legacy functions, so you can just run this in the root of a Puppet module and it
+will do the right thing.
+
+
+## Installation
+
+```
+$ gem install puppet-function-updater
+```
+
+
+## Usage
+
+Run the command `puppet_function_updater` in the root of a Puppet module, then
+inspect all the generated functions for suitability.
+
+
+## Limitations
+
+This is super early in development and has not yet been battle tested.
+
+
+## Disclaimer
+
+I take no liability for the use of this tool.
+
+
+Contact
+-------
+
+binford2k@gmail.com

data/bin/puppet_function_updater

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'logger'
+require 'optparse'
+require 'pfu'
+
+loglevel = Logger::WARN
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: puppet_function_updater [paths]
+
+Run this command with a space separated list of legacy function file paths and it
+will attempt to automatically port them to the modern function API for you.
+
+If you run it from the root of a module directory, it will infer the namespace of
+the module and use it automatically in the generated function names.
+
+If you pass no paths and run it from the root of a module, it will assume that you
+mean to port all the legacy functions.
+
+"
+
+  opts.on('-v', '--verbose', 'Show verbose output') do
+    loglevel = Logger::INFO
+  end
+
+  opts.on('-d', '--debug', 'Show debugging messages') do
+    loglevel = Logger::DEBUG
+  end
+
+  opts.on('-n', '--namespace NAMESPACE', 'The namespace for the generated functions to live in') do |arg|
+    options[:namespace] = arg
+  end
+
+  opts.on('--shell', 'Open a pry shell for debugging (must have Pry installed)') do
+    options[:shell] = true
+  end
+
+  opts.on('--version', 'Show version number') do
+    puts Pfu::VERSION
+    exit
+  end
+
+end.parse!
+
+$logger           = Logger.new($stderr)
+$logger.level     = loglevel
+$logger.formatter = proc { |severity,datetime,progname,msg| "#{severity}: #{msg}\n" }
+
+options[:filenames]   = ARGV.map {|f| File.expand_path f} unless ARGV.empty?
+options[:filenames] ||= ['lib/puppet/parser/functions']
+
+options[:filenames].map! do |path|
+  next path unless File.directory? path
+
+  Dir.glob("#{path}/*")
+end
+options[:filenames].flatten!
+
+if options[:namespace].nil?
+  if File.exist? 'metadata.json'
+    metadata = JSON.parse(File.read('metadata.json'))
+    options[:namespace] = metadata['name'].split('-')[1]
+  else
+    $logger.warn "*********** Namespace is highly suggested! *********** "
+    $logger.warn "      Either run this command from within a module"
+    $logger.warn " or provide a namespace with the --namespace argument!"
+  end
+end
+
+if options[:shell]
+  require 'pry'
+  binding.pry
+  exit 0
+end
+
+Pfu.new(options).refactor!

data/lib/pfu.rb

@@ -0,0 +1,23 @@
+class Pfu
+  require 'pfu/parser'
+  require 'pfu/generator'
+  require 'pfu/version'
+
+  def initialize(options)
+    @filenames = options[:filenames]
+    @namespace = options[:namespace]
+  end
+
+  def refactor!
+    @filenames.each do |path|
+      data = Pfu::Parser.parse(path)
+      data[:namespace] = @namespace
+      Pfu::Generator.write(data)
+    end
+
+    $logger.info "Functions generated. Please inspect for suitability and then"
+    $logger.info "update any Puppet code with the new function names."
+    $logger.info "See https://puppet.com/docs/puppet/latest/custom_functions_ruby.html"
+    $logger.info "for more information about Puppet's modern Ruby function API."
+  end
+end

data/lib/pfu/generator.rb

@@ -0,0 +1,35 @@
+require 'erb'
+require 'fileutils'
+
+class Pfu::Generator
+  def self.write(opts)
+    newpath  = "lib/puppet/functions/#{opts[:namespace]}/#{opts[:name]}.rb"
+    if File.exist?(newpath)
+      $logger.error "Cowardly refusing to overwrite #{newpath}"
+      return
+    end
+
+    opts[:fullname] = case opts[:namespace]
+    when '', nil
+      opts[:name]
+    else
+      "#{opts[:namespace]}::#{opts[:name]}"
+    end
+
+    template = File.join(File.dirname(__FILE__), '..', '..', 'templates', 'function.erb')
+    contents = ERB.new(File.read(template), nil, '-').result(binding)
+
+    begin
+      # syntax check the code before writing it
+      RubyVM::InstructionSequence.compile(contents)
+      FileUtils.mkdir_p("lib/puppet/functions/#{opts[:namespace]}")
+      File.write(newpath, contents)
+      $logger.info "Created #{newpath}."
+    rescue Exception => e
+      $logger.error "Oh crap; the generated function isn't valid Ruby code!"
+      $logger.error e.message
+      $logger.debug e.backtrace.join("\n")
+    end
+
+  end
+end

data/lib/pfu/parser.rb

@@ -0,0 +1,45 @@
+module Puppet
+  module Parser
+    module Functions
+
+      def self.newfunction(funcname, opts = {}, &block)
+        return [funcname, opts, block.source_location.last]
+      end
+
+    end
+  end
+end
+
+
+class Pfu::Parser
+  def self.parse(path)
+    source = File.read(path)
+    lines  = source.split("\n")
+
+    funcname, opts, lineno = eval(source)
+
+
+    stripcount = case source
+    when /module\s+Puppet::Parser::Functions/
+      2
+    when /Puppet::Parser::Functions.newfunction/
+      1
+    end
+
+    block = lines[(lineno-1)..-1].join("\n")
+    block.gsub!(/\A.*\|\w+\|/, '')                               # remove block arg string ("|args|")
+    block.gsub!(/((end|})\s*){#{stripcount}}(^#.*|\s*)*\z/, '')  # remove closing block keywords and trailing comments
+
+    header = lines[0...(lines.index { |l| l =~ /Puppet::Parser::Functions/ })].join("\n")
+    args   = lines[lineno-1].match(/\|\s*(\w+)\s*\|/)[1]
+
+
+    opts[:name]           = funcname.to_sym
+    opts[:header]         = header
+    opts[:args]           = args
+    opts[:implementation] = block
+
+    opts
+  end
+
+end

data/lib/pfu/version.rb

@@ -0,0 +1,3 @@
+class Pfu
+  VERSION = '0.0.1'
+end

data/lib/puppet/functions/testing/direct.rb

@@ -0,0 +1,39 @@
+# This is an autogenerated function, ported from the original legacy version.
+# It /should work/ as is, but will not have all the benefits of the modern
+# function API. You should see the function docs to learn how to add function
+# signatures for type safety and to document this function using puppet-strings.
+#
+# https://puppet.com/docs/puppet/latest/custom_functions_ruby.html
+#
+# ---- original file header ----
+# A comment! Theoretically it would tell you what the function does.
+# ---- original file header ----
+#
+# @summary
+#   Just a naive strlen example
+#
+Puppet::Functions.create_function(:'testing::direct') do
+  # @param args
+  #   The original array of arguments. Port this to individually managed params
+  #   to get the full benefit of the modern function API.
+  #
+  # @return [Data type]
+  #   Describe what the function returns here
+  #
+  dispatch :default_impl do
+    # Call the method named 'default_impl' when this is matched
+    # Port this to match individual params for better type safety
+    repeated_param 'Any', :args
+  end
+
+
+  def default_impl(*args)
+    
+    raise "Wrong number of args" unless args.size == 1         # arg validation
+    raise "Wrong type of args" unless args.first.is_a String   # arg validation
+    value = args.first                                         # arg handling
+
+    value.length                                               # implementation
+
+  end
+end

data/lib/puppet/functions/testing/module.rb

@@ -0,0 +1,39 @@
+# This is an autogenerated function, ported from the original legacy version.
+# It /should work/ as is, but will not have all the benefits of the modern
+# function API. You should see the function docs to learn how to add function
+# signatures for type safety and to document this function using puppet-strings.
+#
+# https://puppet.com/docs/puppet/latest/custom_functions_ruby.html
+#
+# ---- original file header ----
+
+# ---- original file header ----
+#
+# @summary
+#   Just a naive strlen example
+#
+Puppet::Functions.create_function(:'testing::module') do
+  # @param args
+  #   The original array of arguments. Port this to individually managed params
+  #   to get the full benefit of the modern function API.
+  #
+  # @return [Data type]
+  #   Describe what the function returns here
+  #
+  dispatch :default_impl do
+    # Call the method named 'default_impl' when this is matched
+    # Port this to match individual params for better type safety
+    repeated_param 'Any', :args
+  end
+
+
+  def default_impl(*args)
+    
+    raise "Wrong number of args" unless args.size == 1         # arg validation
+    raise "Wrong type of args" unless args.first.is_a String   # arg validation
+    value = args.first                                         # arg handling
+
+    value.length                                               # implementation
+  
+  end
+end

data/lib/puppet/functions/testing/noopts.rb

@@ -0,0 +1,41 @@
+# This is an autogenerated function, ported from the original legacy version.
+# It /should work/ as is, but will not have all the benefits of the modern
+# function API. You should see the function docs to learn how to add function
+# signatures for type safety and to document this function using puppet-strings.
+#
+# https://puppet.com/docs/puppet/latest/custom_functions_ruby.html
+#
+# ---- original file header ----
+#! /usr/bin/env ruby
+# This is a leading comment
+# it might have docs or something
+# ---- original file header ----
+#
+# @summary
+#   
+#
+Puppet::Functions.create_function(:'testing::noopts') do
+  # @param args
+  #   The original array of arguments. Port this to individually managed params
+  #   to get the full benefit of the modern function API.
+  #
+  # @return [Data type]
+  #   Describe what the function returns here
+  #
+  dispatch :default_impl do
+    # Call the method named 'default_impl' when this is matched
+    # Port this to match individual params for better type safety
+    repeated_param 'Any', :args
+  end
+
+
+  def default_impl(*args)
+    
+    raise "Wrong number of args" unless args.size == 1         # arg validation
+    raise "Wrong type of args" unless args.first.is_a String   # arg validation
+    value = args.first                                         # arg handling
+
+    value.length                                               # implementation
+
+  end
+end

data/templates/function.erb

@@ -0,0 +1,33 @@
+# This is an autogenerated function, ported from the original legacy version.
+# It /should work/ as is, but will not have all the benefits of the modern
+# function API. You should see the function docs to learn how to add function
+# signatures for type safety and to document this function using puppet-strings.
+#
+# https://puppet.com/docs/puppet/latest/custom_functions_ruby.html
+#
+# ---- original file header ----
+<%= opts[:header] %>
+# ---- original file header ----
+#
+# @summary
+#   <%= opts[:doc] %>
+#
+Puppet::Functions.create_function(:'<%= opts[:fullname] %>') do
+  # @param <%= opts[:args] %>
+  #   The original array of arguments. Port this to individually managed params
+  #   to get the full benefit of the modern function API.
+  #
+  # @return [Data type]
+  #   Describe what the function returns here
+  #
+  dispatch :default_impl do
+    # Call the method named 'default_impl' when this is matched
+    # Port this to match individual params for better type safety
+    repeated_param 'Any', :<%= opts[:args] %>
+  end
+
+
+  def default_impl(*<%= opts[:args] %>)
+    <%= opts[:implementation] %>
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: puppet-function-updater
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Ford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-27 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Run this command with a space separated list of either function file paths, or
+  directories containing functions. If omitted, it will default to porting all the
+  legacy functions, so you can just run this in the root of a Puppet module and it
+  will do the right thing.
+email: ben.ford@puppet.com
+executables:
+- puppet_function_updater
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/puppet_function_updater
+- lib/pfu.rb
+- lib/pfu/generator.rb
+- lib/pfu/parser.rb
+- lib/pfu/version.rb
+- lib/puppet/functions/testing/direct.rb
+- lib/puppet/functions/testing/module.rb
+- lib/puppet/functions/testing/noopts.rb
+- templates/function.erb
+homepage: 
+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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Automagically ports legacy Puppet functions to the modern API.
+test_files: []