pdk 3.0.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c39902d0ebbac37358fd3fccf5de760b47f77860054b08864ccdae63150b7597
-  data.tar.gz: 6a4d8beb3013edf1ed946b9cf94cd90b055ad63500102e131734600c81c3a5a5
+  metadata.gz: 61c49c154cc69ce1e3c47ddfdd089b42c9c4c5e610bfb2e6caf3256939a16d5d
+  data.tar.gz: 420c70b35bfaf64077b990f6853bfc92062659fc7ba36379cb053232b99313a5
 SHA512:
-  metadata.gz: 7af78ce8b0c4bb9122081a2c6449d862da04c9fec85d428b2e8ace3e88a74930fcf809462062b07994307c54c3ee5a827a83ae26e5c67b95f659c3f5c0cb89b5
-  data.tar.gz: c5af71c375d94c9e22f4c7ae284213a39aaa87b8bc21980580ce4e79743979d4cbb967f330c775dcd2ebc4d3046c4c9c5080480172e07dec33afd9546b94da7e
+  metadata.gz: 3e2e8f1e63a936c310459a67a14b632e00a4ac1694fa4cc77f2849b3d19bf09cc9a5e4a19d7ce3e3a0eb6493a31141c76a72bc98d30cbb4eb7ffd1f5d3da7ca0
+  data.tar.gz: fe219a60e2cf9f7263e1b8fd8e721f143349aa3f03125649e551f9978ae3a9012c4b051f21b2707a266ed31a67772ad6c3cef026f1c5a1a0dadaf8257dc888dc

data/CHANGELOG.md

@@ -5,7 +5,29 @@ 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).
 
-## [v3.0.1](https://github.com/puppetlabs/pdk/tree/v3.0.1) - 2023-12-07
+## [v3.2.0](https://github.com/puppetlabs/pdk/tree/v3.2.0) - 2024-05-02
+
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v3.1.0...v3.2.0)
+
+### Fixed
+
+- (CAT-1807)  Remove analytics from the PDK [#1339](https://github.com/puppetlabs/pdk/pull/1339) ([david22swan](https://github.com/david22swan))
+
+## [v3.1.0](https://github.com/puppetlabs/pdk/tree/v3.1.0) - 2024-04-11
+
+[Full Changelog](https://github.com/puppetlabs/pdk/compare/v3.0.1...v3.1.0)
+
+### Added
+
+- Allow `pdk convert` and `pdk update` to work in a ControlRepo context [#1310](https://github.com/puppetlabs/pdk/pull/1310) ([garrettrowell](https://github.com/garrettrowell))
+- Support executable templates [#1289](https://github.com/puppetlabs/pdk/pull/1289) ([nabertrand](https://github.com/nabertrand))
+
+### Fixed
+
+- (CAT-1796) Fix missing locale gem [#1337](https://github.com/puppetlabs/pdk/pull/1337) ([LukasAud](https://github.com/LukasAud))
+- (CAT-1703) Convert concurrent-ruby from a pin to a pessimistic constraint [#1312](https://github.com/puppetlabs/pdk/pull/1312) ([david22swan](https://github.com/david22swan))
+
+## [v3.0.1](https://github.com/puppetlabs/pdk/tree/v3.0.1) - 2023-12-13
 
 [Full Changelog](https://github.com/puppetlabs/pdk/compare/v3.0.0...v3.0.1)
 

data/lib/pdk/cli/build.rb

@@ -22,8 +22,6 @@ module PDK
           log_level: :info
         )
 
-        PDK::CLI::Util.analytics_screen_view('build', opts)
-
         module_metadata = PDK::Module::Metadata.from_file('metadata.json')
 
         # TODO: Ensure forge metadata has been set, or call out to interview

data/lib/pdk/cli/bundle.rb

@@ -23,8 +23,6 @@ module PDK
         screen_view_name << args[0] if args.size >= 1
         screen_view_name << args[1] if args.size >= 2 && args[0] == 'exec'
 
-        PDK::CLI::Util.analytics_screen_view(screen_view_name.join('_'))
-
         # Ensure that the correct Ruby is activated before running command.
         puppet_env = PDK::CLI::Util.puppet_from_opts_or_env({})
         PDK::Util::RubyVersion.use(puppet_env[:ruby_version])

data/lib/pdk/cli/console.rb

@@ -34,8 +34,6 @@ module PDK
 
         PDK::CLI::Util.validate_puppet_version_opts(processed_options)
 
-        PDK::CLI::Util.analytics_screen_view('console', args)
-
         # TODO: figure out if we need to remove default configs set by puppet
         # so it is scoped for the module only
         # "--environmentpath"...

data/lib/pdk/cli/convert.rb

@@ -18,7 +18,9 @@ module PDK
         # Write the context information to the debug log
         PDK.context.to_debug_log
 
-        raise PDK::CLI::ExitWithError, '`pdk convert` can only be run from inside a valid module directory.' unless PDK.context.is_a?(PDK::Context::Module)
+        unless PDK.context.is_a?(PDK::Context::Module) || PDK.context.is_a?(PDK::Context::ControlRepo)
+          raise PDK::CLI::ExitWithError, '`pdk convert` can only be run from inside a valid module directory.'
+        end
 
         raise PDK::CLI::ExitWithError, 'You can not specify --noop and --force when converting a module' if opts[:noop] && opts[:force]
 
@@ -31,8 +33,6 @@ module PDK
 
         PDK::CLI::Util.validate_template_opts(opts)
 
-        PDK::CLI::Util.analytics_screen_view('convert', opts)
-
         if opts[:'skip-interview'] && opts[:'full-interview']
           PDK.logger.info 'Ignoring --full-interview and continuing with --skip-interview.'
           opts[:'full-interview'] = false

data/lib/pdk/cli/env.rb

@@ -17,8 +17,6 @@ module PDK
 
         PDK::CLI::Util.validate_puppet_version_opts(opts)
 
-        PDK::CLI::Util.analytics_screen_view('env')
-
         # Ensure that the correct Ruby is activated before running command.
         puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
         PDK::Util::RubyVersion.use(puppet_env[:ruby_version])

data/lib/pdk/cli/new/class.rb

@@ -22,8 +22,6 @@ module PDK
 
         raise PDK::CLI::ExitWithError, format("'%{name}' is not a valid class name", name: class_name) unless Util::OptionValidator.valid_class_name?(class_name)
 
-        PDK::CLI::Util.analytics_screen_view('new_class', opts)
-
         updates = PDK::Generate::PuppetClass.new(PDK.context, class_name, opts).run
         PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
       end

data/lib/pdk/cli/new/defined_type.rb

@@ -20,8 +20,6 @@ module PDK
 
         raise PDK::CLI::ExitWithError, format("'%{name}' is not a valid defined type name", name: defined_type_name) unless Util::OptionValidator.valid_defined_type_name?(defined_type_name)
 
-        PDK::CLI::Util.analytics_screen_view('new_defined_type', opts)
-
         require 'pdk/generate/defined_type'
 
         updates = PDK::Generate::DefinedType.new(PDK.context, defined_type_name, opts).run

data/lib/pdk/cli/new/fact.rb

@@ -17,8 +17,6 @@ module PDK
 
         raise PDK::CLI::ExitWithError, format("'%{name}' is not a valid fact name", name: fact_name) unless Util::OptionValidator.valid_fact_name?(fact_name)
 
-        PDK::CLI::Util.analytics_screen_view('new_fact', opts)
-
         require 'pdk/generate/fact'
 
         updates = PDK::Generate::Fact.new(PDK.context, fact_name, opts).run

data/lib/pdk/cli/new/function.rb

@@ -18,8 +18,6 @@ module PDK
 
         raise PDK::CLI::ExitWithError, format("'%{name}' is not a valid function name", name: function_name) unless Util::OptionValidator.valid_function_name?(function_name)
 
-        PDK::CLI::Util.analytics_screen_view('new_function', opts)
-
         require 'pdk/generate/function'
         updates = PDK::Generate::Function.new(PDK.context, function_name, opts).run
         PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)

data/lib/pdk/cli/new/module.rb

@@ -22,8 +22,6 @@ module PDK
 
         PDK::CLI::Util.validate_template_opts(opts)
 
-        PDK::CLI::Util.analytics_screen_view('new_module', opts)
-
         if opts[:'skip-interview'] && opts[:'full-interview']
           PDK.logger.info 'Ignoring --full-interview and continuing with --skip-interview.'
           opts[:'full-interview'] = false

data/lib/pdk/cli/new/provider.rb

@@ -17,8 +17,6 @@ module PDK
 
         raise PDK::CLI::ExitWithError, format("'%{name}' is not a valid provider name", name: provider_name) unless Util::OptionValidator.valid_provider_name?(provider_name)
 
-        PDK::CLI::Util.analytics_screen_view('new_provider', opts)
-
         require 'pdk/generate/provider'
 
         updates = PDK::Generate::Provider.new(PDK.context, provider_name, opts).run

data/lib/pdk/cli/new/task.rb

@@ -24,8 +24,6 @@ module PDK
 
         raise PDK::CLI::ExitWithError, format("'%{name}' is not a valid task name", name: task_name) unless Util::OptionValidator.valid_task_name?(task_name)
 
-        PDK::CLI::Util.analytics_screen_view('new_task', opts)
-
         updates = PDK::Generate::Task.new(PDK.context, task_name, opts).run
         PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
       end

data/lib/pdk/cli/new/test.rb

@@ -39,8 +39,6 @@ module PDK
         begin
           generator, obj = PDK::Util::PuppetStrings.find_object(object_name)
 
-          PDK::CLI::Util.analytics_screen_view('new_test', opts)
-
           updates = generator.new(PDK.context, obj['name'], opts.merge(spec_only: true)).run
           PDK::CLI::Util::UpdateManagerPrinter.print_summary(updates, tense: :past)
         rescue PDK::Util::PuppetStrings::NoObjectError

data/lib/pdk/cli/release/prep.rb

@@ -28,8 +28,6 @@ module PDK
 
         Release.prepare_interview(opts) unless opts[:force]
 
-        Release.send_analytics("release #{cmd.name}", opts)
-
         release = PDK::Module::Release.new(nil, opts)
 
         Release.module_compatibility_checks!(release, opts)

data/lib/pdk/cli/release/publish.rb

@@ -37,8 +37,6 @@ module PDK
 
         Release.prepare_publish_interview(TTY::Prompt.new(help_color: :cyan), opts) unless opts[:force]
 
-        Release.send_analytics("release #{cmd.name}", opts)
-
         release = PDK::Module::Release.new(nil, opts)
 
         release.run

data/lib/pdk/cli/release.rb

@@ -41,8 +41,6 @@ module PDK
 
         Release.prepare_interview(opts) unless opts[:force]
 
-        Release.send_analytics('release', opts)
-
         release = PDK::Module::Release.new(nil, opts)
 
         Release.module_compatibility_checks!(release, opts)
@@ -81,12 +79,6 @@ module PDK
         end
       end
 
-      # Send_analytics for the given command and Cri options
-      def self.send_analytics(command, opts)
-        # Don't pass tokens to analytics
-        PDK::CLI::Util.analytics_screen_view(command, opts.reject { |k, _| k == :'forge-token' })
-      end
-
       def self.prepare_interview(opts)
         questions = []
 

data/lib/pdk/cli/test/unit.rb

@@ -34,8 +34,6 @@ module PDK
 
         PDK::CLI::Util.module_version_check
 
-        PDK::CLI::Util.analytics_screen_view('test_unit', opts)
-
         # Ensure that the bundled gems are up to date and correct Ruby is activated before running or listing tests.
         puppet_env = PDK::CLI::Util.puppet_from_opts_or_env(opts)
         PDK::Util::RubyVersion.use(puppet_env[:ruby_version])

data/lib/pdk/cli/update.rb

@@ -14,7 +14,9 @@ module PDK
         # Write the context information to the debug log
         PDK.context.to_debug_log
 
-        raise PDK::CLI::ExitWithError, '`pdk update` can only be run from inside a valid module directory.' unless PDK.context.is_a?(PDK::Context::Module)
+        unless PDK.context.is_a?(PDK::Context::Module) || PDK.context.is_a?(PDK::Context::ControlRepo)
+          raise PDK::CLI::ExitWithError, '`pdk update` can only be run from inside a valid module directory.'
+        end
 
         raise PDK::CLI::ExitWithError, 'This module does not appear to be PDK compatible. To make the module compatible with PDK, run `pdk convert`.' unless PDK::Util.module_pdk_compatible?
 
@@ -31,8 +33,6 @@ module PDK
           end
         end
 
-        PDK::CLI::Util.analytics_screen_view('update', opts)
-
         updater = PDK::Module::Update.new(PDK.context.root_path, opts)
 
         if updater.pinned_to_puppetlabs_template_tag?

data/lib/pdk/cli/util.rb

@@ -245,44 +245,6 @@ module PDK
         raise PDK::CLI::ExitWithError, '--template-url may not be used to specify paths containing #\'s.'
       end
       module_function :validate_template_opts
-
-      def analytics_screen_view(screen_name, opts = {})
-        require 'pdk/analytics'
-
-        dimensions = {
-          ruby_version: RUBY_VERSION
-        }
-
-        cmd_opts = opts.dup.reject do |_, v|
-          v.nil? || (v.respond_to?(:empty?) && v.empty?)
-        end
-
-        if (format_args = cmd_opts.delete(:format))
-          formats = PDK::CLI::Util::OptionNormalizer.report_formats(format_args)
-          dimensions[:output_format] = formats.map { |r| r[:method].to_s.delete_prefix('write_') }.sort.uniq.join(',')
-        else
-          dimensions[:output_format] = 'default'
-        end
-
-        safe_opts = [:'puppet-version', :'pe-version']
-        safe_bools = [true, false]
-        redacted_opts = cmd_opts.map do |k, v|
-          value = if safe_bools.include?(v) || safe_opts.include?(k)
-                    v
-                  else
-                    'redacted'
-                  end
-          "#{k}=#{value}"
-        end
-        dimensions[:cli_options] = redacted_opts.join(',') unless redacted_opts.empty?
-
-        ignored_env_vars = ['PDK_ANALYTICS_CONFIG', 'PDK_DISABLE_ANALYTICS']
-        env_vars = PDK::Util::Env.select { |k, _| k.start_with?('PDK_') && !ignored_env_vars.include?(k) }.map { |k, v| "#{k}=#{v}" }
-        dimensions[:env_vars] = env_vars.join(',') unless env_vars.empty?
-
-        PDK.analytics.screen_view(screen_name, **dimensions)
-      end
-      module_function :analytics_screen_view
     end
   end
 end

data/lib/pdk/cli/validate.rb

@@ -29,7 +29,6 @@ module PDK
         require 'pdk/validate'
 
         if opts[:list]
-          PDK::CLI::Util.analytics_screen_view('validate', opts)
           PDK.logger.info(format('Available validators: %{validator_names}', validator_names: PDK::Validate.validator_names.join(', ')))
           exit 0
         end
@@ -75,12 +74,6 @@ module PDK
         end
         validators_to_run = PDK::Validate.validator_names if validators_to_run.nil?
 
-        if validators_to_run.sort == PDK::Validate.validator_names.sort
-          PDK::CLI::Util.analytics_screen_view('validate', opts)
-        else
-          PDK::CLI::Util.analytics_screen_view(['validate', validators_to_run.sort].flatten.join('_'), opts)
-        end
-
         # Subsequent arguments are targets.
         targets.concat(args.to_a[1..]) if args.length > 1
 

data/lib/pdk/cli.rb

@@ -16,7 +16,6 @@ module Cri
     class CriExitException
       def initialize(is_error:)
         @is_error = is_error
-        PDK.analytics.event('CLI', 'invalid command', label: PDK::CLI.anonymised_args.join(' ')) if error?
       end
     end
   end
@@ -56,7 +55,6 @@ module PDK
 
     def self.run(args)
       @args = args
-      PDK::Config.analytics_config_interview! unless PDK::Util::Env['PDK_DISABLE_ANALYTICS'] || PDK::Config.analytics_config_exist?
       @base_cmd.run(args)
     rescue PDK::CLI::ExitWithError => e
       PDK.logger.send(e.log_level, e.message)

data/lib/pdk/config/namespace.rb

@@ -24,7 +24,7 @@ module PDK
       #   a child of (defaults to nil).
       # @option params [self] :persistent_defaults whether default values should be persisted
       #   to disk when evaluated. By default they are not persisted to disk. This is typically
-      #   used for settings which a randomly generated, instead of being deterministic, e.g. analytics user-id
+      #   used for settings which a randomly generated, instead of being deterministic, e.g. module_defaults author
       # @param block [Proc] a block that is evaluated within the new instance.
       def initialize(name = nil, file: nil, parent: nil, persistent_defaults: false, &block)
         @file = PDK::Util::Filesystem.expand_path(file) unless file.nil?
@@ -162,7 +162,7 @@ module PDK
         new_hash = {}
         settings.each_pair { |k, v| new_hash[k] = v.value }
         @mounts.each_pair { |k, mount_point| new_hash[k] = mount_point.to_h if mount_point.include_in_parent? }
-        new_hash.delete_if { |_k, v| v.nil? } # rubocop :disable Style/CollectionCompact
+        new_hash.delete_if { |_k, v| v.nil? }
         new_hash
       end
 
@@ -238,7 +238,7 @@ module PDK
       #  Returns true when filter is nil.
       #  Returns true if the filter is exactly the same name as the setting.
       #  Returns true if the name is a sub-key of the filter e.g.
-      #    Given a filter of user.module_defaults, `user.module_defaults.author` will return true, but `user.analytics.disabled` will return false.
+      #    Given a filter of user.module_defaults, `user.module_defaults.author` will return true, but `user.pdk_feature_flags.requested` will return false.
       #
       # @param name [String] The setting name to test.
       # @param filter [String] The filter used to test on the name.

data/lib/pdk/config/setting.rb

@@ -9,9 +9,9 @@ module PDK
     #
     # @example
     #
-    # PDK::Config::Namespace.new('analytics') do
-    #   setting :disabled do
-    #     validate PDK::Config::Validator.boolean
+    # PDK::Config::Namespace.new('module_defaults') do
+    #   setting :author do
+    #     validate PDK::Config::Validator.string
     #     default_to { false }
     #   end
     # end

data/lib/pdk/config.rb

@@ -19,7 +19,6 @@ module PDK
     # @option options [String]                        'system.module_defaults.path' Path to the system module answers PDK configuration file
     # @option options [String]                        'user.path'                   Path to the user PDK configuration file
     # @option options [String]                        'user.module_defaults.path'   Path to the user module answers PDK configuration file
-    # @option options [String]                        'user.analytics.path'         Path to the user analytics PDK configuration file
     # @option options [PDK::Context::AbstractContext] 'context'                     The context that the configuration should be created in
     def initialize(options = nil)
       options = {} if options.nil?
@@ -28,7 +27,6 @@ module PDK
         'system.module_defaults.path' => PDK::Config.system_answers_path,
         'user.path' => PDK::Config.user_config_path,
         'user.module_defaults.path' => PDK::AnswerFile.default_answer_file_path,
-        'user.analytics.path' => PDK::Config.analytics_config_path,
         'context' => PDK.context
       }.merge(options)
     end
@@ -51,27 +49,6 @@ module PDK
       @user_config ||= PDK::Config::JSON.new('user', file: local_options['user.path']) do
         mount :module_defaults, PDK::Config::JSON.new(file: local_options['user.module_defaults.path'])
 
-        # Due to the json-schema gem having issues with Windows based paths, and only supporting Draft 05 (or less) do
-        # not use JSON validation yet.  Once PDK drops support for EOL rubies, we will be able to use the json_schemer gem
-        # Which has much more modern support
-        # Reference - https://github.com/puppetlabs/pdk/pull/777
-        # Reference - https://tickets.puppetlabs.com/browse/PDK-1526
-        mount :analytics, PDK::Config::YAML.new(file: local_options['user.analytics.path'], persistent_defaults: true) do
-          setting :disabled do
-            validate PDK::Config::Validator.boolean
-            default_to { PDK::Config.bolt_analytics_config.fetch('disabled', true) }
-          end
-
-          setting 'user-id' do
-            validate PDK::Config::Validator.uuid
-            default_to do
-              require 'securerandom'
-
-              PDK::Config.bolt_analytics_config.fetch('user-id', SecureRandom.uuid)
-            end
-          end
-        end
-
         # Display the feature flags
         mount :pdk_feature_flags, PDK::Config::Namespace.new('pdk_feature_flags') do
           setting 'available' do
@@ -191,18 +168,6 @@ module PDK
       deep_set_object(value, options[:force], send(all_scopes[scope_name]), *names[1..])
     end
 
-    def self.bolt_analytics_config
-      file = PDK::Util::Filesystem.expand_path('~/.puppetlabs/bolt/analytics.yaml')
-      PDK::Config::YAML.new(file: file)
-    rescue PDK::Config::LoadError => e
-      PDK.logger.debug format('Unable to load %{file}: %{message}', file: file, message: e.message)
-      PDK::Config::YAML.new
-    end
-
-    def self.analytics_config_path
-      PDK::Util::Env['PDK_ANALYTICS_CONFIG'] || File.join(File.dirname(PDK::Util.configdir), 'puppet', 'analytics.yml')
-    end
-
     def self.user_config_path
       File.join(PDK::Util.configdir, 'user_config.json')
     end
@@ -224,51 +189,6 @@ module PDK
       File.join(json_schemas_path, "#{name}_schema.json")
     end
 
-    def self.analytics_config_exist?
-      PDK::Util::Filesystem.file?(analytics_config_path)
-    end
-
-    def self.analytics_config_interview!
-      require 'pdk/cli/util'
-
-      return unless PDK::CLI::Util.interactive?
-
-      pre_message =
-        format('PDK collects anonymous usage information to help us understand how ' \
-               'it is being used and make decisions on how to improve it. You can ' \
-               'find out more about what data we collect and how it is used in the ' \
-               "PDK documentation at %{url}.\n", url: 'https://puppet.com/docs/pdk/latest/pdk_install.html')
-      post_message =
-        format('You can opt in or out of the usage data collection at any time by ' \
-               'editing the analytics configuration file at %{path} and changing ' \
-               "the '%{key}' value.", path: PDK::Config.analytics_config_path, key: 'disabled')
-
-      questions = [
-        {
-          name: 'enabled',
-          question: 'Do you consent to the collection of anonymous PDK usage information?',
-          type: :yes
-        }
-      ]
-
-      require 'pdk/cli/util/interview'
-
-      PDK.logger.info(text: pre_message, wrap: true)
-      prompt = TTY::Prompt.new(help_color: :cyan)
-      interview = PDK::CLI::Util::Interview.new(prompt)
-      interview.add_questions(questions)
-      answers = interview.run
-
-      if answers.nil?
-        PDK.logger.info 'No answer given, opting out of analytics collection.'
-        PDK.config.set(['user', 'analytics', 'disabled'], true)
-      else
-        PDK.config.set(['user', 'analytics', 'disabled'], !answers['enabled'])
-      end
-
-      PDK.logger.info(text: post_message, wrap: true)
-    end
-
     private
 
     # :nocov: This is a private method and is tested elsewhere

data/lib/pdk/module/convert.rb

@@ -148,7 +148,7 @@ module PDK
           module_name = new_metadata.nil? ? 'new-module' : new_metadata.data['name']
           metadata_for_render = new_metadata.nil? ? {} : new_metadata.data
 
-          template_dir.render_new_module(module_name, metadata_for_render) do |relative_file_path, file_content, file_status|
+          template_dir.render_new_module(module_name, metadata_for_render) do |relative_file_path, file_content, file_status, file_executable|
             absolute_file_path = File.join(module_dir, relative_file_path)
             case file_status
             when :unmanage
@@ -156,12 +156,17 @@ module PDK
             when :delete
               update_manager.remove_file(absolute_file_path)
             when :init
-              update_manager.add_file(absolute_file_path, file_content) if convert? && !PDK::Util::Filesystem.exist?(absolute_file_path)
+              if convert? && !PDK::Util::Filesystem.exist?(absolute_file_path)
+                update_manager.add_file(absolute_file_path, file_content)
+                update_manager.make_file_executable(absolute_file_path) if file_executable
+              end
             when :manage
               if PDK::Util::Filesystem.exist?(absolute_file_path)
                 update_manager.modify_file(absolute_file_path, file_content)
+                update_manager.make_file_executable(absolute_file_path) if file_executable && !PDK::Util::Filesystem.executable?(absolute_file_path)
               else
                 update_manager.add_file(absolute_file_path, file_content)
+                update_manager.make_file_executable(absolute_file_path) if file_executable
               end
             end
           end

data/lib/pdk/module/metadata.rb

@@ -117,7 +117,7 @@ module PDK
       def to_json(*_args)
         require 'json'
 
-        JSON.pretty_generate(@data.dup.delete_if { |_key, value| value.nil? }) # rubocop:disable Style/CollectionCompact
+        JSON.pretty_generate(@data.dup.delete_if { |_key, value| value.nil? })
       end
 
       def write!(path)

data/lib/pdk/module/update_manager.rb

@@ -11,6 +11,7 @@ module PDK
         @modified_files = Set.new
         @added_files = Set.new
         @removed_files = Set.new
+        @executable_files = Set.new
         @diff_cache = {}
       end
 
@@ -37,6 +38,13 @@ module PDK
         @removed_files << path
       end
 
+      # Store a pending file execute mode change.
+      #
+      # @param path [String] The path to the file to be made executable.
+      def make_file_executable(path)
+        @executable_files << path
+      end
+
       # Generate a summary of the changes that will be applied to the module.
       #
       # @raise (see #calculate_diffs)
@@ -49,7 +57,8 @@ module PDK
         {
           added: @added_files,
           removed: @removed_files.select { |f| PDK::Util::Filesystem.exist?(f) },
-          modified: @diff_cache.compact
+          modified: @diff_cache.compact,
+          'made executable': @executable_files
         }
       end
 
@@ -60,7 +69,8 @@ module PDK
       def changes?
         !changes[:added].empty? ||
           !changes[:removed].empty? ||
-          changes[:modified].any? { |_, value| !value.nil? }
+          changes[:modified].any? { |_, value| !value.nil? } ||
+          !changes[:'made executable'].empty?
       end
 
       # Check if the update manager will change the specified file upon sync.
@@ -72,13 +82,15 @@ module PDK
       def changed?(path)
         changes[:added].any? { |add| add[:path] == path } ||
           changes[:removed].include?(path) ||
-          changes[:modified].key?(path)
+          changes[:modified].key?(path) ||
+          changes[:'made executable'].include?(path)
       end
 
       def clear!
         @modified_files.clear
         @added_files.clear
         @removed_files.clear
+        @executable_files.clear
         nil
       end
 
@@ -100,6 +112,10 @@ module PDK
         files_to_write.each do |file|
           write_file(file[:path], file[:content])
         end
+
+        @executable_files.each do |file|
+          update_execute_bits(file)
+        end
       end
 
       # Remove a file from disk.
@@ -215,6 +231,16 @@ module PDK
 
         output.join($INPUT_RECORD_SEPARATOR)
       end
+
+      # Set the execute bits on a file
+      def update_execute_bits(path)
+        require 'pdk/util/filesystem'
+
+        PDK.logger.debug(format("making '%{path}' executable", path: path))
+        PDK::Util::Filesystem.make_executable(path)
+      rescue Errno::EACCES
+        raise PDK::CLI::ExitWithError, format("You do not have permission to make '%{path}' executable", path: path)
+      end
     end
   end
 end

data/lib/pdk/report/event.rb

@@ -53,7 +53,7 @@ module PDK
       # @raise [ArgumentError] (see #sanitise_data)
       def initialize(data)
         sanitise_data(data).each do |key, value|
-          instance_variable_set("@#{key}", value)
+          instance_variable_set(:"@#{key}", value)
         end
       end
 

data/lib/pdk/template/renderer/v1/legacy_template_dir.rb

@@ -43,7 +43,6 @@ module PDK
           # @api private
           def config_for(dest_path, sync_config_path = nil)
             require 'pdk/util'
-            require 'pdk/analytics'
 
             module_root = PDK::Util.module_root
             sync_config_path ||= File.join(module_root, '.sync.yml') unless module_root.nil?
@@ -56,22 +55,20 @@ module PDK
               @config = conf_defaults
               @config.deep_merge!(@sync_config, knockout_prefix: '---') unless @sync_config.nil?
             end
-            file_config = @config.fetch(:global, {})
+            file_config = @config.fetch('common', {}).clone
             file_config['module_metadata'] = @module_metadata
             file_config.merge!(@config.fetch(dest_path, {})) unless dest_path.nil?
             file_config.merge!(@config).tap do |c|
               if uri.default?
-                file_value = if c['unmanaged']
-                               'unmanaged'
-                             elsif c['delete']
-                               'deleted'
-                             elsif @sync_config&.key?(dest_path)
-                               'customized'
-                             else
-                               'default'
-                             end
-
-                PDK.analytics.event('TemplateDir', 'file', label: dest_path, value: file_value)
+                if c['unmanaged']
+                  'unmanaged'
+                elsif c['delete']
+                  'deleted'
+                elsif @sync_config&.key?(dest_path)
+                  'customized'
+                else
+                  'default'
+                end
               end
             end
           end

data/lib/pdk/template/renderer/v1/renderer.rb

@@ -95,7 +95,9 @@ module PDK
                 end
               end
 
-              yield dest_path, dest_content, dest_status
+              dest_executable = config['manage_execute_permissions'] && PDK::Util::Filesystem.executable?(File.join(template_loc, template_file))
+
+              yield dest_path, dest_content, dest_status, dest_executable
             end
           end
           # :nocov:

data/lib/pdk/template.rb

@@ -44,9 +44,6 @@ module PDK
         template_dir = TemplateDir.instance(uri, fetcher.path, context)
         template_dir.metadata = fetcher.metadata
 
-        template_type = uri.default? ? 'default' : 'custom'
-        PDK.analytics.event('TemplateDir', 'initialize', label: template_type)
-
         yield template_dir
       end
       nil

data/lib/pdk/util/filesystem.rb

@@ -27,6 +27,11 @@ module PDK
       end
       module_function :read_file
 
+      def make_executable(file)
+        FileUtils.chmod('a+x', file)
+      end
+      module_function :make_executable
+
       # :nocov:
       # These methods just wrap core Ruby functionality and
       # can be ignored for code coverage
@@ -133,6 +138,11 @@ module PDK
         end
       end
       module_function :mv
+
+      def executable?(*args)
+        File.executable?(*args)
+      end
+      module_function :executable?
       # :nocov:
     end
   end

data/lib/pdk/version.rb

@@ -1,4 +1,4 @@
 module PDK
-  VERSION = '3.0.1'.freeze
-  TEMPLATE_REF = '3.0.1'.freeze
+  VERSION = '3.2.0'.freeze
+  TEMPLATE_REF = '3.2.0'.freeze
 end

data/lib/pdk.rb

@@ -1,5 +1,4 @@
 module PDK
-  autoload :Analytics, 'pdk/analytics'
   autoload :AnswerFile, 'pdk/answer_file'
   autoload :Bolt, 'pdk/bolt'
   autoload :Config, 'pdk/config'
@@ -58,17 +57,4 @@ module PDK
 
     requested_feature_flags.include?(flagname)
   end
-
-  def self.analytics
-    @analytics ||= PDK::Analytics.build_client(
-      logger: PDK.logger,
-      disabled: PDK::Util::Env['PDK_DISABLE_ANALYTICS'] || PDK.config.get_within_scopes('analytics.disabled', ['user', 'system']),
-      user_id: PDK.config.get_within_scopes('analytics.user-id', ['user', 'system']),
-      app_id: "UA-139917834-#{PDK::Util.development_mode? ? '2' : '1'}",
-      client: :google_analytics,
-      app_name: 'pdk',
-      app_version: PDK::VERSION,
-      app_installer: PDK::Util.package_install? ? 'package' : 'gem'
-    )
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdk
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-20 00:00:00.000000000 Z
+date: 2024-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -204,48 +204,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.1.10
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.1.10
-- !ruby/object:Gem::Dependency
-  name: facter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: httpclient
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.8.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.8.3
 - !ruby/object:Gem::Dependency
   name: deep_merge
   requirement: !ruby/object:Gem::Requirement
@@ -273,10 +231,6 @@ files:
 - README.md
 - exe/pdk
 - lib/pdk.rb
-- lib/pdk/analytics.rb
-- lib/pdk/analytics/client/google_analytics.rb
-- lib/pdk/analytics/client/noop.rb
-- lib/pdk/analytics/util.rb
 - lib/pdk/answer_file.rb
 - lib/pdk/bolt.rb
 - lib/pdk/cli.rb
@@ -321,7 +275,6 @@ files:
 - lib/pdk/cli/util/update_manager_printer.rb
 - lib/pdk/cli/validate.rb
 - lib/pdk/config.rb
-- lib/pdk/config/analytics_schema.json
 - lib/pdk/config/errors.rb
 - lib/pdk/config/ini_file.rb
 - lib/pdk/config/ini_file_setting.rb

data/lib/pdk/analytics/client/google_analytics.rb

@@ -1,141 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Analytics
-    module Client
-      class GoogleAnalytics
-        PROTOCOL_VERSION  = 1
-        TRACKING_URL      = 'https://google-analytics.com/collect'.freeze
-        CUSTOM_DIMENSIONS = {
-          operating_system: :cd1,
-          output_format: :cd2,
-          ruby_version: :cd3,
-          cli_options: :cd4,
-          env_vars: :cd5
-        }.freeze
-
-        attr_reader :user_id, :logger, :app_name, :app_id, :app_version, :app_installer
-
-        def initialize(opts)
-          # lazy-load expensive gem code
-          require 'concurrent/configuration'
-          require 'concurrent/future'
-          require 'httpclient'
-          require 'locale'
-          require 'pdk/analytics/util'
-
-          @http = HTTPClient.new
-          @user_id = opts[:user_id]
-          @executor = Concurrent.global_io_executor
-          @os = PDK::Analytics::Util.fetch_os_async
-          @logger = opts[:logger]
-          @app_name = opts[:app_name]
-          @app_id = opts[:app_id]
-          @app_version = opts[:app_version]
-          @app_installer = opts[:app_installer]
-        end
-
-        def screen_view(screen, **kwargs)
-          custom_dimensions = walk_keys(kwargs) do |k|
-            CUSTOM_DIMENSIONS[k] || raise(format("Unknown analytics key '%{key}'", key: k))
-          end
-
-          screen_view_params = {
-            # Type
-            t: 'screenview',
-            # Screen Name
-            cd: screen
-          }.merge(custom_dimensions)
-
-          submit(base_params.merge(screen_view_params))
-        end
-
-        def event(category, action, label: nil, value: nil, **kwargs)
-          custom_dimensions = walk_keys(kwargs) do |k|
-            CUSTOM_DIMENSIONS[k] || raise(format("Unknown analytics key '%{key}'", key: k))
-          end
-
-          event_params = {
-            # Type
-            t: 'event',
-            # Event Category
-            ec: category,
-            # Event Action
-            ea: action
-          }.merge(custom_dimensions)
-
-          # Event Label
-          event_params[:el] = label if label
-          # Event Value
-          event_params[:ev] = value if value
-
-          submit(base_params.merge(event_params))
-        end
-
-        def submit(params)
-          # Handle analytics submission in the background to avoid blocking the
-          # app or polluting the log with errors
-          Concurrent::Future.execute(executor: @executor) do
-            require 'json'
-
-            logger.debug "Submitting analytics: #{JSON.pretty_generate(params)}"
-            @http.post(TRACKING_URL, params)
-            logger.debug 'Completed analytics submission'
-          end
-        end
-
-        # These parameters have terrible names. See this page for complete documentation:
-        # https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
-        def base_params
-          require 'locale'
-
-          {
-            v: PROTOCOL_VERSION,
-            # Client ID
-            cid: user_id,
-            # Tracking ID
-            tid: app_id,
-            # Application Name
-            an: app_name,
-            # Application Version
-            av: app_version,
-            # Application Installer ID
-            aiid: app_installer,
-            # Anonymize IPs
-            aip: true,
-            # User locale
-            ul: Locale.current.to_rfc,
-            # Custom Dimension 1 (Operating System)
-            cd1: @os.value
-          }
-        end
-
-        # If the user is running a very fast command, there may not be time for
-        # analytics submission to complete before the command is finished. In
-        # that case, we give a little buffer for any stragglers to finish up.
-        # 250ms strikes a balance between accomodating slower networks while not
-        # introducing a noticeable "hang".
-        def finish
-          @executor.shutdown
-          @executor.wait_for_termination(0.25)
-        end
-
-        private
-
-        def walk_keys(data, &block)
-          case data
-          when Hash
-            data.each_with_object({}) do |(k, v), acc|
-              v = walk_keys(v, &block)
-              acc[yield(k)] = v
-            end
-          when Array
-            data.map { |v| walk_keys(v, &block) }
-          else
-            data
-          end
-        end
-      end
-    end
-  end
-end

data/lib/pdk/analytics/client/noop.rb

@@ -1,25 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Analytics
-    module Client
-      class Noop
-        attr_reader :logger
-
-        def initialize(opts)
-          @logger = opts[:logger]
-        end
-
-        def screen_view(screen, **_kwargs)
-          logger.debug "Skipping submission of '#{screen}' screenview because analytics is disabled"
-        end
-
-        def event(category, action, **_kwargs)
-          logger.debug "Skipping submission of '#{category} #{action}' event because analytics is disabled"
-        end
-
-        def finish; end
-      end
-    end
-  end
-end

data/lib/pdk/analytics/util.rb

@@ -1,18 +0,0 @@
-require 'pdk'
-
-module PDK
-  module Analytics
-    module Util
-      def self.fetch_os_async
-        require 'concurrent/configuration'
-        require 'concurrent/future'
-
-        Concurrent::Future.execute(executor: :io) do
-          os = Facter.value('os')
-
-          os.nil? ? 'unknown' : "#{os['name']} #{os.fetch('release', {}).fetch('major', '')}".strip
-        end
-      end
-    end
-  end
-end

data/lib/pdk/analytics.rb

@@ -1,30 +0,0 @@
-require 'pdk'
-
-autoload :Logger, 'logger'
-
-module PDK
-  module Analytics
-    autoload :Util, 'pdk/analytics/util'
-
-    module Client
-      autoload :Noop, 'pdk/analytics/client/noop'
-      autoload :GoogleAnalytics, 'pdk/analytics/client/google_analytics'
-    end
-
-    def self.build_client(opts = {})
-      opts[:logger] ||= ::Logger.new($stderr)
-      opts[:client] ||= :noop
-
-      if opts[:disabled]
-        opts[:logger].debug 'Analytics opt-out is set, analytics will be disabled'
-        opts[:client] = :noop
-      end
-
-      client_const = opts[:client].to_s.split('_').map(&:capitalize).join
-      PDK::Analytics::Client.const_get(client_const).new(opts)
-    rescue StandardError => e
-      opts[:logger].debug "Failed to initialize analytics client, analytics will be disabled: #{e}"
-      PDK::Analytics::Client::Noop.new(opts)
-    end
-  end
-end

data/lib/pdk/config/analytics_schema.json

@@ -1,26 +0,0 @@
-{
-  "definitions": {},
-  "$schema": "http://json-schema.org/draft-06/schema#",
-  "$id": "http://puppet.com/schema/does_not_exist.json",
-  "type": "object",
-  "title": "The PDK Analytics YAML Schema",
-  "properties": {
-    "disabled": {
-      "$id": "#/properties/disabled",
-      "type": "boolean",
-      "title": "Disabled property",
-      "examples": [
-        false
-      ]
-    },
-    "user-id": {
-      "$id": "#/properties/user-id",
-      "type": "string",
-      "title": "The User-id for analytics",
-      "examples": [
-        "cb9ed65f-37dc-48d8-9863-8bd09cbb61c7"
-      ],
-      "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$"
-    }
-  }
-}