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, #default_guard_interpreter, #elapsed_time, #enclosing_provider, #not_if_args, #only_if_args, #params, #provider, #recipe_name, #resource_name, #retries, #retry_delay, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, #after_created, #as_json, #cookbook_version, #custom_exception_message, #customize_exception, #defined_at, #delayed_notifications, dsl_name, #epic_fail, #events, #guard_interpreter, #identity, identity_attr, #ignore_failure, #immediate_notifications, #inspect, #is, json_create, #load_prior_resource, #method_missing, #name, #node, node_map, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, provider_base, #provider_for_action, provides, #resolve_notification_references, resource_for_node, resource_matching_short_name, #resources, #run_action, #sensitive, #should_skip?, #state, state_attrs, strict_const_defined?, #subscribes, #supports, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, #validate_action, #validate_resource_spec!

Methods included from Mixin::ConvertToClassName

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

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_ivar

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::PlatformIntrospection

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

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 Mixin::ParamsValidate

#lazy, #set_or_return, #validate

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.



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

def initialize(name, run_context=nil)
  super
  @destination = name
  @resource_name = :scm
  @enable_submodules = false
  @enable_checkout = true
  @revision = "HEAD"
  @remote = "origin"
  @ssh_wrapper = nil
  @depth = nil
  @allowed_actions.push(:checkout, :export, :sync, :diff, :log)
  @action = [:sync]
  @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 



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

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”



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

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

#destination(arg = nil) ⇒ Object 



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

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

#enable_checkout(arg = nil) ⇒ Object 



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

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

#enable_submodules(arg = nil) ⇒ Object 



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

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

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



176
177
178
179
180
181
182
 
# File 'lib/chef/resource/scm.rb', line 176

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

#group(arg = nil) ⇒ Object 



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

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

#remote(arg = nil) ⇒ Object 



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

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

#repository(arg = nil) ⇒ Object 



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

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

#revision(arg = nil) ⇒ Object 



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

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

#ssh_wrapper(arg = nil) ⇒ Object 



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

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

#svn_arguments(arg = nil) ⇒ Object 



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

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 



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

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_password(arg = nil) ⇒ Object 



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

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

#svn_username(arg = nil) ⇒ Object 



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

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

#timeout(arg = nil) ⇒ Object 



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

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

#user(arg = nil) ⇒ Object 



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

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