Class: Chef::Provider::SystemdUnit

Inherits:
Chef::Provider show all
Includes:
Mixin::Which
Defined in:
lib/chef/provider/systemd_unit.rb

Instance Attribute Summary

Attributes inherited from Chef::Provider

#action, #after_resource, #current_resource, #logger, #new_resource, #run_context

Instance Method Summary collapse

Methods inherited from Chef::Provider

action, action_description, action_descriptions, #action_nothing, #check_resource_semantics!, #cleanup_after_converge, #compile_and_converge_action, #converge_by, #converge_if_changed, #cookbook_name, #description, #events, include_resource_dsl?, include_resource_dsl_module, #initialize, #introduced, #load_after_resource, #node, #process_resource_requirements, provides, provides?, #recipe_name, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use, use_inline_resources, #validate_required_properties!, #whyrun_mode?, #whyrun_supported?

Methods included from Mixin::Provides

#provided_as, #provides, #provides?

Methods included from Mixin::DescendantsTracker

#descendants, descendants, direct_descendants, #direct_descendants, find_descendants_by_name, #find_descendants_by_name, #inherited, store_inherited

Methods included from Mixin::LazyModuleInclude

#descendants, #include, #included

Methods included from Mixin::PowershellOut

#powershell_out, #powershell_out!

Methods included from Mixin::WindowsArchitectureHelper

#assert_valid_windows_architecture!, #disable_wow64_file_redirection, #forced_32bit_override_required?, #is_i386_process_on_x86_64_windows?, #node_supports_windows_architecture?, #node_windows_architecture, #restore_wow64_file_redirection, #valid_windows_architecture?, #with_os_architecture, #wow64_architecture_override_required?, #wow64_directory

Methods included from DSL::Secret

#default_secret_config, #default_secret_service, #secret, #with_secret_config, #with_secret_service

Methods included from DSL::RenderHelpers

#render_json, #render_toml, #render_yaml

Methods included from DSL::ReaderHelpers

#parse_file, #parse_json, #parse_toml, #parse_yaml

Methods included from DSL::Powershell

#ps_credential

Methods included from DSL::RegistryHelper

#registry_data_exists?, #registry_get_subkeys, #registry_get_values, #registry_has_subkeys?, #registry_key_exists?, #registry_value_exists?

Methods included from DSL::ChefVault

#chef_vault, #chef_vault_item, #chef_vault_item_for_environment

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search, #tagged?

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Methods included from DSL::PlatformIntrospection

#older_than_win_2012_or_8?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Methods included from DSL::Recipe

#exec, #have_resource_class_for?, #resource_class_for

Methods included from DSL::Definitions

add_definition, #evaluate_resource_definition, #has_resource_definition?

Methods included from DSL::Resources

add_resource_dsl, remove_resource_dsl

Methods included from DSL::Cheffish

load_cheffish

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::IncludeRecipe

#include_recipe, #load_recipe

Methods included from Mixin::NotifyingBlock

#notifying_block, #subcontext_block

Methods included from DSL::DeclareResource

#build_resource, #declare_resource, #delete_resource, #delete_resource!, #edit_resource, #edit_resource!, #find_resource, #find_resource!, #resources, #with_run_context

Methods included from DSL::Compliance

#include_input, #include_profile, #include_waiver

Constructor Details

This class inherits a constructor from Chef::Provider

Instance Method Details

#active? ⇒ Boolean

Returns:

  • (Boolean) 


224
225
226
227
 
# File 'lib/chef/provider/systemd_unit.rb', line 224

def active?
  # Note: "activating" is not active (as with type=notify or a oneshot)
  systemd_unit_status["ActiveState"] == "active"
end

#define_resource_requirements ⇒ Object 



50
51
52
53
54
55
56
57
 
# File 'lib/chef/provider/systemd_unit.rb', line 50

def define_resource_requirements
  super

  requirements.assert(:create) do |a|
    a.assertion { IniParse.parse(new_resource.to_ini) }
    a.failure_message "Unit content is not valid INI text"
  end
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


229
230
231
232
233
234
 
# File 'lib/chef/provider/systemd_unit.rb', line 229

def enabled?
  # See https://github.com/systemd/systemd/blob/master/src/systemctl/systemctl-is-enabled.c
  # Note: enabled-runtime is excluded because this is volatile, and the state of enabled-runtime
  # specifically means that the service is not enabled
  %w{enabled static generated alias indirect}.include?(systemd_unit_status["UnitFileState"])
end

#indirect? ⇒ Boolean

Returns:

  • (Boolean) 


246
247
248
 
# File 'lib/chef/provider/systemd_unit.rb', line 246

def indirect?
  systemd_unit_status["UnitFileState"] == "indirect"
end

#load_current_resource ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/chef/provider/systemd_unit.rb', line 34

def load_current_resource
  @current_resource = Chef::Resource::SystemdUnit.new(new_resource.name)

  current_resource.unit_name(new_resource.unit_name)
  current_resource.content(::File.read(unit_path)) if ::File.exist?(unit_path)
  current_resource.user(new_resource.user)
  current_resource.enabled(enabled?)
  current_resource.active(active?)
  current_resource.masked(masked?)
  current_resource.static(static?)
  current_resource.indirect(indirect?)
  current_resource.triggers_reload(new_resource.triggers_reload)

  current_resource
end

#masked? ⇒ Boolean

Returns:

  • (Boolean) 


236
237
238
239
240
 
# File 'lib/chef/provider/systemd_unit.rb', line 236

def masked?
  # Note: masked-runtime is excluded, because runtime is volatile, and
  # because masked-runtime is not masked.
  systemd_unit_status["UnitFileState"] == "masked"
end

#static? ⇒ Boolean

Returns:

  • (Boolean) 


242
243
244
 
# File 'lib/chef/provider/systemd_unit.rb', line 242

def static?
  systemd_unit_status["UnitFileState"] == "static"
end

#systemd_unit_status ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/chef/provider/systemd_unit.rb', line 59

def systemd_unit_status
  @systemd_unit_status ||= begin
    # Collect all the status information for a unit and return it at once
    # This may fail if we are managing a template unit (e.g. with '@'), in which case
    # we just ignore the error because unit status is irrelevant in that case
    s = shell_out(*systemctl_cmd, "show", "-p", "UnitFileState", "-p", "ActiveState", new_resource.unit_name, **systemctl_opts)
    # e.g. /bin/systemctl --system show -p UnitFileState -p ActiveState syslog.socket
    # Returns something like:
    # ActiveState=inactive
    # UnitFileState=static
    status = {}
    s.stdout.each_line do |line|
      k, v = line.strip.split("=")
      status[k] = v
    end

    status
  end
end