Class: Xolo::Server::Version

Inherits:

Core::BaseClasses::Version

• Object
• Core::BaseClasses::Version
• Xolo::Server::Version

Includes:

Comparable, Helpers::JamfPro, Helpers::Log, Helpers::Notification, Helpers::TitleEditor, Mixins::Changelog, Mixins::VersionJamfAccess, Mixins::VersionTedAccess

Defined in:

lib/xolo/server/version.rb

Overview

Xolo Version/Patch as used on the Xolo Server

The code in this file mostly deals with the data on the Xolo server itself, and general methods for manipulating the version.

Code for interacting with the Title Editor and Jamf Pro are in the helpers and mixins.

NOTE be sure to only instantiate these using the server's 'instantiate_version' method, or else they might not have all the correct innards

Constant Summary

VERSIONS_DIRNAME =

On the server, xolo versions are represented by JSON files in the 'versions' directory of the title directory

So a title 'foobar' would have a directory (Xolo::Server::DATA_DIR)/titles/foobar/

In there will be a 'versions' dir containing json files for each version of the title.

'versions'

JAMF_PKG_NOTES_VERS_PH =

'XOLO-VERSION-HERE'

JAMF_PKG_NOTES_TITLE_PH =

'XOLO-TITLE-HERE'

JAMF_PKG_NOTES_PREFIX =

The 'Notes' of a jamf pkg are the Xolo Title Description, with this prepended

<<~ENDNOTES
  This package is maintained by 'xolo', to install version '#{JAMF_PKG_NOTES_VERS_PH}' of title '#{JAMF_PKG_NOTES_TITLE_PH}'. The description in Xolo is:


ENDNOTES

MAX_PKG_DELETION_THREADS =

10

STUB_PATCH_VERSION =

STUB PATCH

We create a fake 'stub' patch with all ted titles so that we can activate the title before any real version is added and also accept any EA/version_script, either manually or automatically

This version should never be available to any mac, and needs no patch policies or packages.

It should also never be deleted until the title itself is deleted.

'0.0.0x0'

STUB_PATCH_CAPABILITY_CRITERION_NAME =

machines that can install this version

'Operating System Version'

STUB_PATCH_CAPABILITY_CRITERION_OPERATOR =

'less than or equal'

STUB_PATCH_CAPABILITY_CRITERION_VALUE =

'10.0'

STUB_PATCH_COMPONENT_NAME =

machines that have this version installed

'Xolo Stub'

STUB_PATCH_COMPONENT_CRITERION_NAME =

'Application Title'

STUB_PATCH_COMPONENT_CRITERION_OPERATOR =

'is'

STUB_PATCH_COMPONENT_CRITERION_VALUE =

'XoloStub-DoesNotExist.app'

Constants included from Mixins::VersionJamfAccess

Mixins::VersionJamfAccess::JAMF_POLICY_NAME_AUTO_INSTALL_SFX, Mixins::VersionJamfAccess::JAMF_POLICY_NAME_AUTO_REINSTALL_SFX, Mixins::VersionJamfAccess::JAMF_POLICY_NAME_MANUAL_INSTALL_SFX, Mixins::VersionJamfAccess::JAMF_SMART_GROUP_NAME_INSTALLED_SFX

Constants included from Mixins::Changelog

Mixins::Changelog::TITLE_CHANGELOG_FILENAME

Constants included from Helpers::Notification

Helpers::Notification::ALERT_TOOL_EMAIL_PREFIX, Helpers::Notification::DFT_EMAIL_FROM

Constants included from Helpers::JamfPro

Helpers::JamfPro::PATCH_REPORT_JPAPI_PAGE_SIZE, Helpers::JamfPro::PATCH_REPORT_UNKNOWN_VERSION

Instance Attribute Summary

• #changes_for_update ⇒ Hash readonly

  Also when applying updates, this will hold the changes being made: the differences between tne current attributs and the new_data_for_update We'll figure this out at the start of the update and can use it later to 1) avoid doing things we don't need to 2) log the changes in the change log at the very end.

• #current_action ⇒ Symbol

  The current action being taken on this title one of :creating, :updating, :deleting.

• #jamf_auto_install_policy_name ⇒ Object readonly

  Jamf auto-install policies are named this.

• #jamf_auto_reinstall_policy_name ⇒ Object readonly

  Jamf auto re-install policies are named this.

• #jamf_installed_group_name ⇒ String readonly

  For each version there will be a smart group containing all macs that have that version of the title installed.

• #jamf_manual_install_policy_name ⇒ Object (also: #jamf_manual_install_trigger) readonly

  Jamf manual install policies are named this.

• #jamf_obj_name_pfx ⇒ Object readonly

  Jamf object names start with this.

• #jamf_patch_policy_name ⇒ Object readonly

  Jamf Patch Policy is named this.

• #jamf_pkg_id ⇒ Object readonly

  The Jamf Package object has this jamf id.

• #new_data_for_update ⇒ Object readonly

  when applying updates, the new data is stored here so it can be accessed by update-methods and compared to the current instanace values both for updating the title, and the versions.

• #pkg_is_from_autopkg ⇒ Boolean

  Is the pkg being processed now from an autopkg recipe?.

• #server_app_instance ⇒ Object

  The instance of Xolo::Server::App that instantiated this version object.

• #ted_id_number ⇒ Object

  The Windoo::Patch#patchId.

• #title_object(refresh: false) ⇒ Xolo::Server::Title

  This might have been set already if we were instantiated via our title.

Class Method Summary

• .add_version_via_subscription(title_object:, new_version:) ⇒ void

  add a new version in response to a patch title update webhook event.

• .all_versions(title) ⇒ Array<String>

  A list of all known versions for a title, just the basenames of all the version files with the extension removed.

• .data_dir(title, version) ⇒ Pathname

  The the local directory containing various files specific to the given version of a title.

• .data_file(title, version) ⇒ Pathname

  The the local JSON file containing the current values for the given version of a title.

• .in_ted?(patch_id, cnx:) ⇒ Boolean

  Does the given patch exist in the Title Editor?.

• .load(title, version) ⇒ Xolo::Server::Title

  Instantiate from the local JSON file containing the current values for the given version of a title.

• .locked?(title, version) ⇒ Boolean

  Is a version locked for updates?.

• .manifest_file(title, version) ⇒ Pathname

  The the local xml plist file containing the .pkg manifest for the given version of a title.

• .pkg_deletion_pool ⇒ Queue

  The package-deletion thread pool.

• .pkg_deletion_pool_info ⇒ Hash

  info about the current pkg deletion pool state, for the /state route.

• .version_dir(title) ⇒ Pathname

  The directory containing subdirectories for each version of a title.

• .version_dirs(title) ⇒ Array<Pathname>

  All version directories for a title.

Instance Method Summary

• #<=>(other) ⇒ Object

  version comparison.

• #admin ⇒ String

  This can be manually set earlier in the request handling to use a non-standard admin username.

• #create ⇒ void

  Save a new version, adding to the local filesystem, Jamf Pro, and the Title Editor as needed This should be running in the context of #with_streaming.

• #creating? ⇒ Boolean

  Are we creating this version?.

• #data_dir ⇒ Pathname

  The data directory for this version.

• #data_file ⇒ Pathname

  The JSON data file for this version.

• #delete(update_title: true, deleting_title: false) ⇒ void

  Delete the version.

• #deleting? ⇒ Boolean

  Are we deleting this version?.

• #deprecate ⇒ void

  deprecate this version.

• #excluded_groups_to_use(ttl_obj: nil) ⇒ Array<String>

  The scope excluded groups to use in policies and patch policies for all versions of this title.

• #handle_autopkg_during_create ⇒ Object

  Do autopkg stuff during creation.

• #initialize(data_hash) ⇒ Version constructor

  NOTE: be sure to only instantiate these using the servers 'instantiate_version' method, or else they might not have all the correct innards.

• #jamf_cnx(refresh: false) ⇒ Jamf::Connection

  A single Jamf Pro API connection to use for the life of this instance.

• #lock ⇒ Object

  Lock this version for updates.

• #locked? ⇒ Boolean

  Is this version locked for updates?.

• #managed? ⇒ Boolean

  or a managed title?.

• #manifest_file ⇒ Pathname

  The manifest plist file for this version.

• #order_index ⇒ Integer

  The index of this version in the title's reversed version_order array.

• #pilot_groups_to_use ⇒ Array<String>

  The scope target groups to use in policies and patch policies during pilot This is defined in each version, and inherited when new versions are created.

• #progress(msg, log: :debug, alert: false) ⇒ void

  Append a message to the progress stream file, optionally sending it also to the log.

• #release(rollback:) ⇒ void

  Release this version, possibly rolling back from a previously newer version This should only be called by the title.

• #release_groups_to_use(ttl_obj: nil) ⇒ Array<String>

  The scope target groups to use in policies and patch policies when the version is released This is defined in the title and applies to all versions.

• #releasing? ⇒ Boolean

  Are we releasing this version?.

• #repair ⇒ Object

  Repair this version.

• #repairing? ⇒ Boolean

  Are we repairing this version?.

• #reset_to_pilot ⇒ void

  Reset this version to 'pilot' status, since we are rolling back to a previous version.

• #save_local_data ⇒ void

  Save our current data out to our JSON data file This overwrites the existing data.

• #session ⇒ Hash
• #skip ⇒ void

  skip this version.

• #subscribed? ⇒ Boolean

  Is this version part of a subscribed title?.

• #ted_cnx ⇒ Windoo::Connection

  A single Title Editor connection to use for the life of this instance.

• #ted_patch(refresh: false) ⇒ Windoo::Patch

  TODO: maybe pass in an appropriate Windoo::SoftwareTitle, so we don't have to use refresh all the time to re-fetch, if we just re-fetched from elsewhere?.

• #ted_title(refresh: false) ⇒ Windoo::SoftwareTitle

  The Windoo::SoftwareTitle object that represents this version's title in the title editor.

• #to_h ⇒ Object

  Add more data to our hash.

• #unlock ⇒ Object

  Unlock this version for updates.

• #update(new_data) ⇒ void

  Update a this version, updating to the local filesystem, Jamf Pro, and the Title Editor as needed.

• #update_local_instance_values ⇒ void

  Update our instance attributes with any new data before saving the changes back out to the file system.

• #updating? ⇒ Boolean

  Are we updating this version?.

Methods included from Mixins::VersionTedAccess

#create_patch_in_ted, #delete_patch_from_ted, #enable_ted_patch, #get_patch_component_criteria_params, included, #repair_ted_patch, #set_app_component, #set_ea_component, #set_patch_capabilites, #set_patch_killapps, #set_ted_patch_component_criteria, #ted_patch_url, #update_patch_in_ted

Methods included from Mixins::VersionJamfAccess

#activate_managed_patch_version_in_jamf, #activate_patch_version_in_jamf, #activate_subscribed_patch_version_in_jamf, #assign_pkg_to_patch_in_jamf, #configure_jamf_auto_install_policy, #configure_jamf_auto_reinstall_policy, #configure_jamf_installed_group, #configure_jamf_manual_install_policy, #configure_jamf_patch_policy, #configure_patch_pol_for_self_service, #create_in_jamf, #create_jamf_auto_install_policy, #create_jamf_auto_reinstall_policy, #create_jamf_installed_group, #create_jamf_manual_install_policy, #create_jamf_package, #create_jamf_patch_policy, #delete_jamf_package, #delete_version_from_jamf, #deploy_via_mdm, #disable_policies_for_deprecation_or_skipping, #expand_groups_for_deploy, extended, included, #jamf_auto_install_policy, #jamf_auto_install_policy_exist?, #jamf_auto_install_policy_url, #jamf_auto_reinstall_policy, #jamf_auto_reinstall_policy_exist?, #jamf_auto_reinstall_policy_url, #jamf_gui_url, #jamf_installed_group, #jamf_installed_group_criteria, #jamf_installed_group_exist?, #jamf_installed_group_url, #jamf_manual_install_policy, #jamf_manual_install_policy_exist?, #jamf_manual_install_policy_url, #jamf_package, #jamf_package_exist?, #jamf_package_notes, #jamf_package_url, #jamf_patch_policy, #jamf_patch_policy_exist?, #jamf_patch_policy_url, #jamf_patch_version, #patch_report, #remove_exclusions_from_deploy, #remove_invalid_computers_for_deploy, #repair_jamf_auto_install_policy, #repair_jamf_auto_reinstall_policy, #repair_jamf_installed_group, #repair_jamf_manual_install_policy, #repair_jamf_package, #repair_jamf_patch_policy, #repair_jamf_version_objects, #reset_policies_to_pilot, #set_patch_policy_ssvc_icon, #set_policy_exclusions, #set_policy_pilot_groups, #set_policy_release_groups, #set_policy_to_all_targets, #update_excluded_groups, #update_jamf_package_notes, #update_jamf_patch_policy_patch_unknown, #update_jamf_pkg_min_os, #update_jamf_pkg_reboot, #update_pilot_groups, #update_release_groups, #update_version_in_jamf

Methods included from Mixins::Changelog

#backup_changelog, backup_file_dir, #changelog, #changelog_backup_file, #changelog_file, #changelog_lock, changelog_locks, #delete_changelog, #hostname_from_ip, included, #log_change, #log_update_changes, #note_changes_for_update_and_log

Methods included from Helpers::Notification

#email_from, included, #send_alert, #send_email, #send_email_alert, #server_fqdn, #server_name

Methods included from Helpers::Log

included, #log_debug, #log_error, #log_fatal, #log_info, #log_unknown, #log_warn, #logger, #session_svr_obj_id

Methods included from Helpers::TitleEditor

included

Methods included from Helpers::JamfPro

extended, included, #jamf_gui_url, #jamf_obj_name_pfx_base, #jamf_xolo_category_id, #valid_forced_exclusion_group_name

Constructor Details

#initialize(data_hash) ⇒ Version

NOTE: be sure to only instantiate these using the servers 'instantiate_version' method, or else they might not have all the correct innards

# File 'lib/xolo/server/version.rb', line 387

def initialize(data_hash)
  super

  # These attrs aren't defined in the ATTRIBUTES
  # and/or are not stored in the on-disk json file

  @ted_id_number ||= data_hash[:ted_id_number]
  @jamf_pkg_id ||= data_hash[:jamf_pkg_id]

  # and these can be generated now
  @jamf_obj_name_pfx = "#{jamf_obj_name_pfx_base}#{title}-#{version}"

  @jamf_pkg_name ||= @jamf_obj_name_pfx

  @jamf_installed_group_name = "#{jamf_obj_name_pfx}-#{JAMF_SMART_GROUP_NAME_INSTALLED_SFX}"

  @jamf_auto_install_policy_name = "#{jamf_obj_name_pfx}-#{JAMF_POLICY_NAME_AUTO_INSTALL_SFX}"
  @jamf_manual_install_policy_name = "#{jamf_obj_name_pfx}-#{JAMF_POLICY_NAME_MANUAL_INSTALL_SFX}"
  @jamf_auto_reinstall_policy_name = "#{jamf_obj_name_pfx}-#{JAMF_POLICY_NAME_AUTO_REINSTALL_SFX}"

  @jamf_patch_policy_name = @jamf_obj_name_pfx

  # we set @jamf_pkg_file when a pkg is uploaded
  # since we don't know until then if its a .pkg or .zip
  # It will be stored in the local data and reloaded as needed
end

Instance Attribute Details

#changes_for_update ⇒ Hash (readonly)

Also when applying updates, this will hold the changes being made: the differences between tne current attributs and the new_data_for_update We'll figure this out at the start of the update and can use it later to

1. avoid doing things we don't need to
2. log the changes in the change log at the very end

This is a Hash with keys of the attribute names that have changed the values are Hashes with keys of :old and :new e.g. { pilot_groups: { old: ['foo'], new: ['bar'] } }

Returns:

• (Hash)

# File 'lib/xolo/server/version.rb', line 371

def changes_for_update
  @changes_for_update
end

#current_action ⇒ Symbol

Returns The current action being taken on this title one of :creating, :updating, :deleting.

Returns:

• (Symbol) —

  The current action being taken on this title one of :creating, :updating, :deleting

# File 'lib/xolo/server/version.rb', line 375

def current_action
  @current_action
end

#jamf_auto_install_policy_name ⇒ Object (readonly)

Jamf auto-install policies are named this

# File 'lib/xolo/server/version.rb', line 336

def jamf_auto_install_policy_name
  @jamf_auto_install_policy_name
end

#jamf_auto_reinstall_policy_name ⇒ Object (readonly)

Jamf auto re-install policies are named this

# File 'lib/xolo/server/version.rb', line 342

def jamf_auto_reinstall_policy_name
  @jamf_auto_reinstall_policy_name
end

#jamf_installed_group_name ⇒ String (readonly)

For each version there will be a smart group containing all macs that have that version of the title installed. The smart group will be named 'xolo-