Class: Chef::Resource::Scm

Inherits:
Chef::Resource show all
Defined in:
lib/chef/resource/scm.rb

Direct Known Subclasses

Git, Subversion

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #declared_type, #default_guard_interpreter, #elapsed_time, #enclosing_provider, #params, #recipe_name, #resource_initializing, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, action, #action=, action_class, #after_created, allowed_actions, allowed_actions=, #as_json, #before_notifications, #cookbook_version, #current_value, #current_value_does_not_exist!, #custom_exception_message, custom_resource?, #customize_exception, declare_action_class, #declared_key, default_action, default_action=, #defined_at, #delayed_action, #delayed_notifications, #events, from_hash, from_json, #guard_interpreter, #identity, identity_attr, identity_property, #ignore_failure, #immediate_notifications, inherited, #inspect, is_custom_resource!, json_create, load_current_value, #load_from, #lookup_provider_constant, #method_missing, #name, #node, #not_if, #notifies, #notifies_before, #notifies_delayed, #notifies_immediately, #only_if, #provider, #provider=, #provider_for_action, provides, provides?, remove_canonical_dsl, #resolve_notification_references, resource_for_node, resource_matching_short_name, #resource_name, resource_name, resource_name=, #resources, #retries, #retry_delay, #run_action, #sensitive, #should_skip?, sorted_descendants, #source_line_file, #source_line_number, state_attrs, #state_for_resource_reporter, #subscribes, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, use_automatic_resource_name, #validate_action, #validate_resource_spec!, #value_to_text

Methods included from Mixin::ConvertToClassName

#constantize, #convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #normalize_snake_case_name, #snake_case_basename

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::Deprecation

#deprecated_attr, #deprecated_attr_reader, #deprecated_attr_writer, #deprecated_ivar

Methods included from Mixin::Properties

included, #property_is_set?, #reset_property

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from Mixin::ShellOut

#a_to_s, #clean_array, #shell_out, #shell_out!, #shell_out_compact, #shell_out_compact!, #shell_out_compact_timeout, #shell_out_compact_timeout!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Methods included from Mixin::PathSanity

#enforce_path_sanity, #sanitized_path

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::PlatformIntrospection

#docker?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Methods included from DSL::RebootPending

#reboot_pending?

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::DataQuery

#data_bag, #data_bag_item, #search

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Constructor Details

#initialize(name, run_context = nil) ⇒ Scm

Returns a new instance of Scm



31
32
33
34
35
36
37
38
39
40
41
42
# File 'lib/chef/resource/scm.rb', line 31

def initialize(name, run_context = nil)
  super
  @destination = name
  @enable_submodules = false
  @enable_checkout = true
  @revision = "HEAD"
  @remote = "origin"
  @ssh_wrapper = nil
  @depth = nil
  @checkout_branch = "deploy"
  @environment = nil
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::Resource

Instance Method Details

#checkout_branch(arg = nil) ⇒ Object



160
161
162
163
164
165
166
# File 'lib/chef/resource/scm.rb', line 160

def checkout_branch(arg = nil)
  set_or_return(
    :checkout_branch,
    arg,
    :kind_of => String
  )
end

#depth(arg = nil) ⇒ Object

Capistrano and git-deploy use “shallow clone''



112
113
114
115
116
117
118
# File 'lib/chef/resource/scm.rb', line 112

def depth(arg = nil)
  set_or_return(
    :depth,
    arg,
    :kind_of => Integer
  )
end

#destination(arg = nil) ⇒ Object



44
45
46
47
48
49
50
# File 'lib/chef/resource/scm.rb', line 44

def destination(arg = nil)
  set_or_return(
    :destination,
    arg,
    :kind_of => String
  )
end

#enable_checkout(arg = nil) ⇒ Object



128
129
130
131
132
133
134
# File 'lib/chef/resource/scm.rb', line 128

def enable_checkout(arg = nil)
  set_or_return(
    :enable_checkout,
    arg,
    :kind_of => [TrueClass, FalseClass]
  )
end

#enable_submodules(arg = nil) ⇒ Object



120
121
122
123
124
125
126
# File 'lib/chef/resource/scm.rb', line 120

def enable_submodules(arg = nil)
  set_or_return(
    :enable_submodules,
    arg,
    :kind_of => [TrueClass, FalseClass]
  )
end

#environment(arg = nil) ⇒ Object Also known as: env



168
169
170
171
172
173
174
# File 'lib/chef/resource/scm.rb', line 168

def environment(arg = nil)
  set_or_return(
    :environment,
    arg,
    :kind_of => [ Hash ]
  )
end

#group(arg = nil) ⇒ Object



76
77
78
79
80
81
82
# File 'lib/chef/resource/scm.rb', line 76

def group(arg = nil)
  set_or_return(
    :group,
    arg,
    :kind_of => [String, Integer]
  )
end

#remote(arg = nil) ⇒ Object



136
137
138
139
140
141
142
# File 'lib/chef/resource/scm.rb', line 136

def remote(arg = nil)
  set_or_return(
    :remote,
    arg,
    :kind_of => String
  )
end

#repository(arg = nil) ⇒ Object



52
53
54
55
56
57
58
# File 'lib/chef/resource/scm.rb', line 52

def repository(arg = nil)
  set_or_return(
    :repository,
    arg,
    :kind_of => String
  )
end

#revision(arg = nil) ⇒ Object



60
61
62
63
64
65
66
# File 'lib/chef/resource/scm.rb', line 60

def revision(arg = nil)
  set_or_return(
    :revision,
    arg,
    :kind_of => String
  )
end

#ssh_wrapper(arg = nil) ⇒ Object



144
145
146
147
148
149
150
# File 'lib/chef/resource/scm.rb', line 144

def ssh_wrapper(arg = nil)
  set_or_return(
    :ssh_wrapper,
    arg,
    :kind_of => String
  )
end

#svn_arguments(arg = nil) ⇒ Object



94
95
96
97
98
99
100
101
# File 'lib/chef/resource/scm.rb', line 94

def svn_arguments(arg = nil)
  @svn_arguments, arg = nil, nil if arg == false
  set_or_return(
    :svn_arguments,
    arg,
    :kind_of => String
  )
end

#svn_info_args(arg = nil) ⇒ Object



103
104
105
106
107
108
109
# File 'lib/chef/resource/scm.rb', line 103

def svn_info_args(arg = nil)
  @svn_info_args, arg = nil, nil if arg == false
  set_or_return(
    :svn_info_args,
    arg,
    :kind_of => String)
end

#svn_username(arg = nil) ⇒ Object



84
85
86
87
88
89
90
# File 'lib/chef/resource/scm.rb', line 84

def svn_username(arg = nil)
  set_or_return(
    :svn_username,
    arg,
    :kind_of => String
  )
end

#timeout(arg = nil) ⇒ Object



152
153
154
155
156
157
158
# File 'lib/chef/resource/scm.rb', line 152

def timeout(arg = nil)
  set_or_return(
    :timeout,
    arg,
    :kind_of => Integer
  )
end

#user(arg = nil) ⇒ Object



68
69
70
71
72
73
74
# File 'lib/chef/resource/scm.rb', line 68

def user(arg = nil)
  set_or_return(
    :user,
    arg,
    :kind_of => [String, Integer]
  )
end