summaryrefslogtreecommitdiff
path: root/lib/chef/provider/subversion.rb
diff options
context:
space:
mode:
authorSeth Chisamore <schisamo@opscode.com>2012-10-30 10:39:35 -0400
committerSeth Chisamore <schisamo@opscode.com>2012-10-30 10:39:35 -0400
commit24dc69a9a97e82a6e4207de68d6dcc664178249b (patch)
tree19bb289c9f88b4bbab066bc56b95d6d222fd5c35 /lib/chef/provider/subversion.rb
parent9348c1c9c80ee757354d624b7dc1b78ebc7605c4 (diff)
downloadchef-24dc69a9a97e82a6e4207de68d6dcc664178249b.tar.gz
[OC-3564] move core Chef to the repo root \o/ \m/
The opscode/chef repository now only contains the core Chef library code used by chef-client, knife and chef-solo!
Diffstat (limited to 'lib/chef/provider/subversion.rb')
-rw-r--r--lib/chef/provider/subversion.rb214
1 files changed, 214 insertions, 0 deletions
diff --git a/lib/chef/provider/subversion.rb b/lib/chef/provider/subversion.rb
new file mode 100644
index 0000000000..e1f87b4dd8
--- /dev/null
+++ b/lib/chef/provider/subversion.rb
@@ -0,0 +1,214 @@
+#
+# Author:: Daniel DeLeo (<dan@kallistec.com>)
+# Copyright:: Copyright (c) 2008 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+#TODO subversion and git should both extend from a base SCM provider.
+
+require 'chef/log'
+require 'chef/provider'
+require 'chef/mixin/command'
+require 'fileutils'
+
+class Chef
+ class Provider
+ class Subversion < Chef::Provider
+
+ SVN_INFO_PATTERN = /^([\w\s]+): (.+)$/
+
+ include Chef::Mixin::Command
+
+ def whyrun_supported?
+ true
+ end
+
+ def load_current_resource
+ @current_resource = Chef::Resource::Subversion.new(@new_resource.name)
+
+ unless [:export, :force_export].include?(Array(@new_resource.action).first)
+ if current_revision = find_current_revision
+ @current_resource.revision current_revision
+ end
+ end
+ end
+
+ def define_resource_requirements
+ requirements.assert(:all_actions) do |a|
+ # Make sure the parent dir exists, or else fail.
+ # for why run, print a message explaining the potential error.
+ parent_directory = ::File.dirname(@new_resource.destination)
+ a.assertion { ::File.directory?(parent_directory) }
+ a.failure_message(Chef::Exceptions::MissingParentDirectory,
+ "Cannot clone #{@new_resource} to #{@new_resource.destination}, the enclosing directory #{parent_directory} does not exist")
+ a.whyrun("Directory #{parent_directory} does not exist, assuming it would have been created")
+ end
+ end
+
+ def action_checkout
+ if target_dir_non_existent_or_empty?
+ converge_by("perform checkout of #{@new_resource.repository} into #{@new_resource.destination}") do
+ run_command(run_options(:command => checkout_command))
+ end
+ else
+ Chef::Log.debug "#{@new_resource} checkout destination #{@new_resource.destination} already exists or is a non-empty directory - nothing to do"
+ end
+ end
+
+ def action_export
+ if target_dir_non_existent_or_empty?
+ action_force_export
+ else
+ Chef::Log.debug "#{@new_resource} export destination #{@new_resource.destination} already exists or is a non-empty directory - nothing to do"
+ end
+ end
+
+ def action_force_export
+ converge_by("export #{@new_resource.repository} into #{@new_resource.destination}") do
+ run_command(run_options(:command => export_command))
+ end
+ end
+
+ def action_sync
+ assert_target_directory_valid!
+ if ::File.exist?(::File.join(@new_resource.destination, ".svn"))
+ current_rev = find_current_revision
+ Chef::Log.debug "#{@new_resource} current revision: #{current_rev} target revision: #{revision_int}"
+ unless current_revision_matches_target_revision?
+ converge_by("sync #{@new_resource.destination} from #{@new_resource.repository}") do
+ run_command(run_options(:command => sync_command))
+ Chef::Log.info "#{@new_resource} updated to revision: #{revision_int}"
+ end
+ end
+ else
+ action_checkout
+ end
+ end
+
+ def sync_command
+ c = scm :update, @new_resource.svn_arguments, verbose, authentication, "-r#{revision_int}", @new_resource.destination
+ Chef::Log.debug "#{@new_resource} updated working copy #{@new_resource.destination} to revision #{@new_resource.revision}"
+ c
+ end
+
+ def checkout_command
+ c = scm :checkout, @new_resource.svn_arguments, verbose, authentication,
+ "-r#{revision_int}", @new_resource.repository, @new_resource.destination
+ Chef::Log.info "#{@new_resource} checked out #{@new_resource.repository} at revision #{@new_resource.revision} to #{@new_resource.destination}"
+ c
+ end
+
+ def export_command
+ args = ["--force"]
+ args << @new_resource.svn_arguments << verbose << authentication <<
+ "-r#{revision_int}" << @new_resource.repository << @new_resource.destination
+ c = scm :export, *args
+ Chef::Log.info "#{@new_resource} exported #{@new_resource.repository} at revision #{@new_resource.revision} to #{@new_resource.destination}"
+ c
+ end
+
+ # If the specified revision isn't an integer ("HEAD" for example), look
+ # up the revision id by asking the server
+ # If the specified revision is an integer, trust it.
+ def revision_int
+ @revision_int ||= begin
+ if @new_resource.revision =~ /^\d+$/
+ @new_resource.revision
+ else
+ command = scm(:info, @new_resource.repository, @new_resource.svn_info_args, authentication, "-r#{@new_resource.revision}")
+ status, svn_info, error_message = output_of_command(command, run_options)
+ handle_command_failures(status, "STDOUT: #{svn_info}\nSTDERR: #{error_message}")
+ extract_revision_info(svn_info)
+ end
+ end
+ end
+
+ alias :revision_slug :revision_int
+
+ def find_current_revision
+ return nil unless ::File.exist?(::File.join(@new_resource.destination, ".svn"))
+ command = scm(:info)
+ status, svn_info, error_message = output_of_command(command, run_options(:cwd => cwd))
+
+ unless [0,1].include?(status.exitstatus)
+ handle_command_failures(status, "STDOUT: #{svn_info}\nSTDERR: #{error_message}")
+ end
+ extract_revision_info(svn_info)
+ end
+
+ def current_revision_matches_target_revision?
+ (!@current_resource.revision.nil?) && (revision_int.strip.to_i == @current_resource.revision.strip.to_i)
+ end
+
+ def run_options(run_opts={})
+ run_opts[:user] = @new_resource.user if @new_resource.user
+ run_opts[:group] = @new_resource.group if @new_resource.group
+ run_opts
+ end
+
+ private
+
+ def cwd
+ @new_resource.destination
+ end
+
+ def verbose
+ "-q"
+ end
+
+ def extract_revision_info(svn_info)
+ repo_attrs = svn_info.lines.inject({}) do |attrs, line|
+ if line =~ SVN_INFO_PATTERN
+ property, value = $1, $2
+ attrs[property] = value
+ end
+ attrs
+ end
+ rev = (repo_attrs['Last Changed Rev'] || repo_attrs['Revision'])
+ raise "Could not parse `svn info` data: #{svn_info}" if repo_attrs.empty?
+ Chef::Log.debug "#{@new_resource} resolved revision #{@new_resource.revision} to #{rev}"
+ rev
+ end
+
+ # If a username is configured for the SCM, return the command-line
+ # switches for that. Note that we don't need to return the password
+ # switch, since Capistrano will check for that prompt in the output
+ # and will respond appropriately.
+ def authentication
+ return "" unless @new_resource.svn_username
+ result = "--username #{@new_resource.svn_username} "
+ result << "--password #{@new_resource.svn_password} "
+ result
+ end
+
+ def scm(*args)
+ ['svn', *args].compact.join(" ")
+ end
+
+
+ def target_dir_non_existent_or_empty?
+ !::File.exist?(@new_resource.destination) || Dir.entries(@new_resource.destination).sort == ['.','..']
+ end
+ def assert_target_directory_valid!
+ target_parent_directory = ::File.dirname(@new_resource.destination)
+ unless ::File.directory?(target_parent_directory)
+ msg = "Cannot clone #{@new_resource} to #{@new_resource.destination}, the enclosing directory #{target_parent_directory} does not exist"
+ raise Chef::Exceptions::MissingParentDirectory, msg
+ end
+ end
+ end
+ end
+end