PackageChanger 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e42fcbfef88337d942d5dc3d91e33252959b753a3d15cbdf1581bd8eb14463be
-  data.tar.gz: 04504df89dac7433c272baaf28b8f4d409f31932bc06c2cb009daa647ff107b7
+  metadata.gz: 981f3ec735d35c942e1aa40e563b4406b1757757685f4c0786be321101976deb
+  data.tar.gz: 75bcad50ab045e12aab08ec90644ea7101a9ead338b6aa3847be8bb1cb31bc8a
 SHA512:
-  metadata.gz: cfc931f07224a433d2ee321f47dee9b8d068670a312ecf709f4a8eb6ea3cc7ff27b541d6901f639e90793c3c1d3b4fd47c1cd7d5bb1047b6246a8ee2005a15ae
-  data.tar.gz: d550a5ebb9334978ea5608ccc02aadcdeb9503b09ba731a74e9eec7de3085b3ca33078c96928a623cfcf6e462c3b35e334ba9c5c906bf9102ee70ba0917b13fc
+  metadata.gz: b60ab714163bd9917ed5ef194f5c55ec017fadc24715bc47b9f8bb2f54c140fa0257efb36d6007656702362eccf8131cbeb454312f800cdf32367339ff75c9a5
+  data.tar.gz: ab4d87b6ee76e39b2994517721243e440f0f7b9a0544309b299d71dd0c087cf2754da111eb60985597c61114c628af5ec30cd17064477bd1f1a495d40d7df753

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/PackageChanger.gemspec

@@ -40,7 +40,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'ruby-jss', '~> 1.0', '>= 1.2.3'
   spec.add_runtime_dependency 'ruby-jss', '~> 1.0', '>= 1.2.3'
 end

data/README.md

@@ -14,7 +14,9 @@ You can copy a sample file from the data folder inside the installation path of
 
 Once configured, you can use it:
 
-```packagechanger [--silent] --old OldPackageName --new NewPackageName || --list ListedPackage```
+```packagechanger [--silent] [--policy PolicyID] --old OldPackageName --new NewPackageName || --list ListedPackage```
+
+The PolicyID can be either the numeric ID of a JSS policy, or its name between quotes.
 
 Run the first execution with sudo, or change the mode of the file `/private/var/log/packagechanger.log` so all users can write to it.
 

data/bin/PackageChanger

@@ -13,8 +13,8 @@ old_package = nil
 new_package = nil
 list_package = nil
 target_policy = nil
-mode = nil
-result_array = []
+app_title = nil
+version = nil
 silent = false
 
 # The CLI options for GetoptLong
@@ -23,7 +23,11 @@ OPTS = GetoptLong.new(
   ['--old', '-o', GetoptLong::REQUIRED_ARGUMENT],
   ['--new', '-n', GetoptLong::REQUIRED_ARGUMENT],
   ['--list', '-l', GetoptLong::REQUIRED_ARGUMENT],
-  ['--silent', '-s', GetoptLong::NO_ARGUMENT]
+  ['--silent', '-s', GetoptLong::NO_ARGUMENT],
+  ['--patch', '-x', GetoptLong::REQUIRED_ARGUMENT],
+  ['--version', '-v', GetoptLong::REQUIRED_ARGUMENT],
+  ['--test', '-t', GetoptLong::REQUIRED_ARGUMENT],
+  ['--release', '-r', GetoptLong::REQUIRED_ARGUMENT]
 )
 
 logger = PackageChanger::Log.new
@@ -33,7 +37,7 @@ mode = 'change'
 
 OPTS.each do |opt, arg|
   case opt
-  when '--policy'
+  when '--policy', '-p'
     if arg == ''
       puts PackageChanger::USAGE
       logger.write('Missing arguments.')
@@ -45,7 +49,7 @@ OPTS.each do |opt, arg|
       mode = 'single'
     end
 
-  when '--old'
+  when '--old', '-o'
     if arg == ''
       puts PackageChanger::USAGE
       logger.write('Missing arguments.')
@@ -54,7 +58,7 @@ OPTS.each do |opt, arg|
       old_package = arg
     end
 
-  when '--new'
+  when '--new', '-n'
     if arg == ''
       puts PackageChanger::USAGE
       logger.write('Missing arguments.')
@@ -63,7 +67,7 @@ OPTS.each do |opt, arg|
       new_package = arg
     end
 
-  when '--list'
+  when '--list', '-l'
     if arg == ''
       puts PackageChanger::USAGE
       logger.write('Missing arguments.')
@@ -74,13 +78,52 @@ OPTS.each do |opt, arg|
       # Change mode to list if flag is used
       mode = 'list'
     end
-  when '--silent'
+
+  when '--silent', '-s'
     silent = true
 
+  when '--patch', '-x'
+    if arg == ''
+      puts PackageChanger::PATCH_USAGE
+      logger.write('Missing arguments.')
+      exit 1
+    else
+      app_title = arg
+      mode = 'patch'
+    end
+
+  when '--version', '-v'
+    if arg == ''
+      puts PackageChanger::PATCH_USAGE
+      logger.write('Missing arguments.')
+      exit 1
+    else
+      version = arg
+    end
+
+  when '--test', '-t'
+    if arg == ''
+      puts PackageChanger::PATCH_USAGE
+      logger.write('Missing arguments.')
+      exit 1
+    else
+      app_title = arg
+      mode = 'test'
+    end
+
+  when '--release', '-r'
+    if arg == ''
+      puts PackageChanger::PATCH_USAGE
+      logger.write('Missing arguments.')
+      exit 1
+    else
+      app_title = arg
+      mode = 'release'
+    end
   end
 end
 
-unless (old_package && new_package) || list_package
+unless (old_package && new_package) || list_package || (app_title && new_package) || app_title
   puts PackageChanger::USAGE
   logger.write('Missing package names')
   exit 1
@@ -88,6 +131,8 @@ end
 
 begin
   puts PackageChanger::STARTUP unless silent
+
+  # Check for configurations before starting
   if PackageChanger::Configuration::DEFAULT_CONF_FILE.file?
     @config_src = PackageChanger::Configuration::DEFAULT_CONF_FILE.to_s
   elsif PackageChanger::Configuration::SAMPLE_CONF_FILE.file?
@@ -98,16 +143,17 @@ begin
 
   PackageChanger.connect_to_jss(silent)
 
-  if mode == 'list'
+  case mode
+  when 'list'
     unless JSS::Package.valid_id list_package
       logger.write("#{list_package} does not exist")
-      puts PackageChanger::MISSSING_LIST_PACKAGE
+      puts PackageChanger::MISSING_LIST_PACKAGE
       exit 1
     end
 
     result_array = PackageChanger.get_policies_with(list_package, silent, logger)
 
-    if result_array.count > 0
+    if result_array.count.positive?
       puts "\u{1F3C1} The package #{list_package} is used on the following policies: "
       result_array.each do |result|
         puts "\t#{result[:id]} - #{result[:name]}"
@@ -117,16 +163,16 @@ begin
       exit 0
     end
 
-  elsif mode == 'change'
+  when 'change'
     unless JSS::Package.valid_id(old_package) && JSS::Package.valid_id(new_package)
       logger.write("Either #{old_package} or #{new_package} do not exist")
-      puts PackageChanger::MISSSING_PACKAGE
+      puts PackageChanger::MISSING_PACKAGE
       exit 1
     end
 
     result_array = PackageChanger.get_policies_with(old_package, silent)
 
-    if result_array.count > 0
+    if result_array.count.positive?
       puts "The package #{old_package} will be replaced with #{new_package}: "
       logger.write("The package #{old_package} will be replaced with #{new_package}")
       result_array.each do |result|
@@ -134,20 +180,9 @@ begin
         logger.write("\t#{result[:id]} - #{result[:name]}")
       end
 
-      confirmation = ''
-
-      while confirmation !~ /[yn]/i
-        puts 'Please confirm [y/n]:'
-        confirmation = gets.chomp.downcase
-      end
-
-      case confirmation
+      case PackageChanger.confirm
       when 'y'
-        puts 'Processing changes.' unless silent
-        logger.write('Starting changes.')
         PackageChanger.replace_packages(result_array, old_package, new_package, silent, logger)
-        puts "\u{1F3C1} Finished changing packages." unless silent
-        logger.write('Finished changing.')
         exit 0
       when 'n'
         puts 'Cancelling changes.'
@@ -165,18 +200,54 @@ begin
       exit 0
     end
 
-  elsif mode == 'single'
+  when 'patch'
+    patch_title = PackageChanger.check_patch(app_title, new_package, version, silent, logger)
+
+    case PackageChanger.confirm
+    when 'y'
+      PackageChanger.assign_patch(patch_title, new_package, version, silent, logger)
+      exit 0
+    when 'n'
+      puts "\u{1F519} Cancelling changes."
+      logger.write('User cancelled.')
+      exit 0
+    else
+      puts PackageChanger::ERROR
+      logger.write(PackageChanger::ERROR)
+      exit 1
+    end
+
+  when 'test', 'release'
+    patch_policy_id = PackageChanger.check_version_for_mode(app_title, version, mode, silent, logger)
+
+    puts "\u{1f3AB} #{app_title} has a #{mode} patch policy with ID #{patch_policy_id}" unless silent
+    logger.write("#{app_title} has a #{mode} patch policy with ID #{patch_policy_id}")
+
+    case PackageChanger.confirm
+    when 'y'
+      PackageChanger.activate_patch_for_mode(app_title, mode, version, patch_policy_id, silent, logger)
+      exit 0
+    when 'n'
+      puts "\u{1F519} Cancelling changes."
+      logger.write('User cancelled.')
+      exit 0
+    else
+      puts PackageChanger::ERROR
+      logger.write(PackageChanger::ERROR)
+      exit 1
+    end
+
+  when 'single'
     unless JSS::Package.valid_id(old_package) && JSS::Package.valid_id(new_package)
       logger.write("Either #{old_package} or #{new_package} does not exist")
-      puts PackageChanger::MISSSING_PACKAGE
+      puts PackageChanger::MISSING_PACKAGE
       exit 1
     end
 
-
     target_policy = target_policy.match(/[^[:digit:]]+/) ? target_policy : target_policy.to_i
     unless JSS::Policy.valid_id(target_policy)
       logger.write("The policy with id #{target_policy} does not exist.")
-      puts PackageChanger::MISSSING_POLICY
+      puts PackageChanger::MISSING_POLICY
       exit 1
     end
 
@@ -185,14 +256,7 @@ begin
     puts "\u{1F4E6} The package #{old_package}\n\u{27A1 FE0F}  will be replaced with #{new_package}\n\u{1F4CC} in #{changed_pol.name}"
     logger.write("The package #{old_package} will be replaced with #{new_package} in #{changed_pol.name}")
 
-    confirmation = ''
-
-    while confirmation !~ /[yn]/i
-      puts 'Please confirm [y/n]:'
-      confirmation = gets.chomp.downcase
-    end
-
-    case confirmation
+    case PackageChanger.confirm
     when 'y'
       puts "\u{1F3A2} Processing changes." unless silent
       logger.write('Starting changes.')

data/lib/PackageChanger/config.rb

@@ -18,7 +18,9 @@ module PackageChanger
         jamf_port: :to_i,
         jamf_use_ssl: nil,
         jamf_user: nil,
-        jamf_password: nil
+        jamf_password: nil,
+        testers_keyword: nil,
+        release_keyword: nil
     }.freeze
 
     # automatically create accessors for all the CONF_KEYS
@@ -86,4 +88,5 @@ module PackageChanger
   def self.config
     PackageChanger::Configuration.instance
   end
-end # module
+end
+# module

data/lib/PackageChanger/connection.rb

@@ -39,6 +39,8 @@ module PackageChanger
 
   def self.replace_packages_in(changed_pol, old_package, new_package, silent, logger)
     puts 'Starting replacement process' unless silent
+    puts 'Processing changes.' unless silent
+    logger.write('Starting changes.')
 
     puts "Changing #{changed_pol.name}" unless silent
     logger.write("Changing #{changed_pol.name}")
@@ -50,6 +52,9 @@ module PackageChanger
       puts "\u{1F6AB} Changed failed due to error: #{e.message}"
       logger.write("Changed on #{changed_pol.name} failed due to error: #{e.message}")
     end
+    puts "\u{1F3C1} Finished changing packages." unless silent
+    logger.write('Finished changing.')
+
   end
 
   def self.get_policies_with(list_package, silent, logger)
@@ -60,14 +65,7 @@ module PackageChanger
     }
     puts "\u{203C FE0F}  There are #{all_policies.count} policies in your JSS…"
 
-    confirmation = ''
-
-    while confirmation !~ /[yn]/i
-      puts 'Would you like to continue? [y/n]:'
-      confirmation = gets.chomp.downcase
-    end
-
-    case confirmation
+    case confirm
     when 'y'
       pol_count = 1
       all_policies.each do |policy|
@@ -95,4 +93,100 @@ module PackageChanger
     end
   end
 
-end # PackageChanger
+  def self.check_patch(app_title, new_package, version, silent, logger)
+    unless (patch_id = JSS::PatchTitle.valid_id(app_title))
+      logger.write("No patch management for #{app_title} exists")
+      puts PackageChanger::MISSING_PATCH_MGMT
+      exit 1
+    end
+    puts "\u{1f4bb} #{app_title} has a patch policy with ID #{patch_id}." unless silent
+    logger.write("Preparing change to #{app_title} with ID #{patch_id}.")
+
+    unless JSS::Package.valid_id(new_package)
+      logger.write("#{new_package} does not exist")
+      puts PackageChanger::MISSSING_ONE_PACKAGE
+      exit 1
+    end
+    puts "\u{1F4E6} #{new_package} is available in JSS." unless silent
+    logger.write("#{new_package} is available in JSS.")
+
+    patch_title = JSS::PatchTitle.fetch id: patch_id
+    unless patch_title.versions[version]
+      logger.write("#{app_title} does not have version #{version}")
+      puts PackageChanger::MISSING_VERSION
+      exit 1
+    end
+    puts "\u{1f516} #{app_title} has a version #{version}" unless silent
+    logger.write("#{app_title} has a version #{version}")
+
+    patch_title
+  end
+  # check_patch
+
+  def self.assign_patch(patch_title, new_package, version, silent, logger)
+    puts "\u{1F3A2} Updating patch policy." unless silent
+    logger.write("Setting #{new_package} for version #{version} of #{patch_title}")
+    patch_title.versions[version].package = new_package
+    patch_title.update
+    puts "\u{1F3C1} Finished changing patch policy." unless silent
+    logger.write("Patch definition of #{patch_title} updated")
+  end
+  # assign_patch
+
+  def self.check_version_for_mode(app_title, version, mode, silent, logger)
+    unless (patch_id = JSS::PatchTitle.valid_id(app_title))
+      logger.write("No patch management for #{app_title} exists")
+      puts PackageChanger::MISSING_PATCH_MGMT
+      exit 1
+    end
+    puts "\u{1f4bb} #{app_title} has a patch definition with ID #{patch_id}." unless silent
+    logger.write("Preparing change to enable #{mode} of #{app_title} with patch ID #{patch_id}.")
+
+    patch_title = JSS::PatchTitle.fetch id: patch_id
+    patch_version = patch_title.versions[version]
+    unless patch_version&.package_assigned?
+      logger.write("#{app_title} does not have version #{version}")
+      puts PackageChanger::MISSING_VERSION
+      exit 1
+    end
+    puts "\u{1f516} #{app_title} has a version #{version} and it has an assigned package" unless silent
+    logger.write("#{app_title} has a version #{version} and it has an assigned package")
+
+    policies = (JSS::PatchPolicy.all_for_title app_title) # Gets all with the title
+    case mode
+    when 'test'
+      keyword = PackageChanger.config.testers_keyword
+    when 'release'
+      keyword = PackageChanger.config.release_keyword
+    else
+      logger.write("Wrong mode introduced")
+      exit 1
+    end
+
+    begin
+      policies.find { |pol| pol[:name].include? keyword }[:id]
+    rescue StandardError => _e
+      puts PackageChanger::MISSING_POLICY
+      exit 1
+    end
+  end
+  # check_version_for_mode
+
+  def self.activate_patch_for_mode(app_title, mode, version, policy_id, silent, logger)
+    puts "\u{1F3A2} Updating #{mode} patch for #{app_title}." unless silent
+    logger.write("Assigning version #{version} to #{mode} group.")
+    policy = JSS::PatchPolicy.fetch policy_id
+    policy.disable
+    puts "\u{23F8} Patch policy temporary disabled." unless silent
+    policy.target_version = version
+    puts "\u{1F517} Version #{version} assigned." unless silent
+    policy.enable
+    puts "\u{25B6} Patch policy reenabled." unless silent
+    policy.update
+    puts "\u{1F3C1} Values updated." unless silent
+    logger.write("Patch of #{app_title} updated for testers")
+  end
+  # activate_patch_for_mode
+
+end
+# PackageChanger

data/lib/PackageChanger/log.rb

@@ -1,17 +1,13 @@
-
+# frozen_string_literal: true
 module PackageChanger
-
   class Log
-
     DEFAULT_FILE = Pathname.new '/var/log/packagechanger.log'
 
     # date and line format
     DATE_FORMAT = '%Y-%m-%d %H:%M:%S'
 
     def initialize
-      unless DEFAULT_FILE.file? && DEFAULT_FILE.writable?
-        File.write(DEFAULT_FILE, "≈≈≈ PackageChanger ≈≈≈\n", mode: 'a')
-      end
+      File.write(DEFAULT_FILE, "≈≈≈ PackageChanger ≈≈≈\n", mode: 'a') unless (DEFAULT_FILE.file? && DEFAULT_FILE.writable?)
     end
 
     def write(message)
@@ -22,7 +18,7 @@ module PackageChanger
       puts message
       write message
     end
-
-  end # Class Log
-
-end # MOdule
+  end
+  # Class Log
+end
+# MOdule

data/lib/PackageChanger/messages.rb

@@ -8,6 +8,13 @@ module PackageChanger
   Usage: packagechanger [--silent] [--policy PolicyID] --old OldPackageName --new NewPackageName || --list ListedPackage
 "
 
+PATCH_USAGE = "
+
+≈≈≈ PackageChanger ≈≈≈
+
+  Patch definition usage: packagechanger [--silent] --patch PatchDefinitionID --version PatchVersion --new NewPackageName
+"
+
 
   CONFIG_ERROR = "
 
@@ -20,21 +27,42 @@ module PackageChanger
 
 "
 
-  MISSSING_PACKAGE = "
+  MISSING_PACKAGE = "
 
 ≈≈≈ PackageChanger ≈≈≈
 
   \u{1f4a9} Missing packages: One or both of the provided packages do not exist. Please verify.
 "
 
-  MISSSING_POLICY = "
+  MISSING_PATCH_MGMT = "
+
+≈≈≈ PackageChanger ≈≈≈
+
+  \u{1f4a9} Missing patch definition: The provided software title does not have a patch definition. Please verify.
+"
+
+  MISSING_ONE_PACKAGE = "
+
+≈≈≈ PackageChanger ≈≈≈
+
+\u{1f4a9} Missing package: The package provided does not exist in JAMF. Please verify.
+"
+
+  MISSING_VERSION = "
+
+≈≈≈ PackageChanger ≈≈≈
+
+\u{1f4a9} Missing version: The patch definition for the title does not have the provided version registered.
+"
+
+  MISSING_POLICY = "
 
 ≈≈≈ PackageChanger ≈≈≈
 
   \u{1f4a9} Missing policy: The policy ID you provided does not exist. Please verify.
 "
 
-  MISSSING_LIST_PACKAGE = "
+  MISSING_LIST_PACKAGE = "
 
 ≈≈≈ PackageChanger ≈≈≈
 
@@ -59,4 +87,28 @@ module PackageChanger
 STARTUP = "
 ≈≈≈ PackageChanger ≈≈≈
 "
+
+  MISSING_TESTERS = "
+
+≈≈≈ PackageChanger ≈≈≈
+
+  \u{1f4a9} Missing testers group: In order to start testing the patch, a patch policy with the word Testers in its name needs to exist for the title.
+"
+
+  MISSING_PATCH_POLICY = "
+
+≈≈≈ PackageChanger ≈≈≈
+
+  \u{1f4a9} Missing patch policy: The title you are trying to change does not have a patch policy with one of the keywords (test or release) in the title.
+"
+
+  def self.confirm
+    confirmation = ''
+    while confirmation !~ /[yn]/i
+      puts 'Please confirm [y/n]:'
+      confirmation = gets.chomp.downcase
+    end
+    confirmation
+  end
+
 end

data/lib/PackageChanger/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PackageChanger
-  VERSION = "0.2.0"
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: PackageChanger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Bernardo Prieto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: ruby-jss
   requirement: !ruby/object:Gem::Requirement
@@ -102,18 +102,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
 - ".gitignore"
-- ".idea/.rakeTasks"
-- ".idea/PackageChanger.iml"
-- ".idea/misc.xml"
-- ".idea/modules.xml"
-- ".idea/vcs.xml"
-- ".idea/workspace.xml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - PackageChanger-0.1.0.gem
+- PackageChanger-0.2.0.gem
 - PackageChanger.gemspec
 - README.md
 - Rakefile