Class: Capistrano::BundleRsync::SCM Abstract

Inherits:
Base
  • Object
show all
Defined in:
lib/capistrano/bundle_rsync/scm.rb

Overview

This class is abstract.

Base class for SCM strategy providers.

Direct Known Subclasses

Git, LocalGit

Instance Method Summary collapse

Methods inherited from Base

#config, #initialize

Constructor Details

This class inherits a constructor from Capistrano::BundleRsync::Base

Instance Method Details

#check ⇒ Boolean

This method is abstract.

Your implementation should check if the specified remote-repository is available.

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


28
29
30
31
32
 
# File 'lib/capistrano/bundle_rsync/scm.rb', line 28

def check
  raise NotImplementedError.new(
    "Your SCM strategy module should provide a #check method"
  )
end

#clean_release ⇒ Object

This method is abstract.

Clean the contents of the cache-repository onto the release path

Returns:

  • void

Raises:

  • (NotImplementedError) 


76
77
78
79
80
 
# File 'lib/capistrano/bundle_rsync/scm.rb', line 76

def clean_release
  raise NotImplementedError.new(
    "Your SCM strategy module should provide a #clean_release method"
  )
end

#clone ⇒ Object

This method is abstract.

Create a (new) clone of the remote-repository on the deployment target

Returns:

  • void

Raises:

  • (NotImplementedError) 


40
41
42
43
44
 
# File 'lib/capistrano/bundle_rsync/scm.rb', line 40

def clone
  raise NotImplementedError.new(
    "Your SCM strategy module should provide a #clone method"
  )
end

#create_release ⇒ Object

This method is abstract.

Copy the contents of the cache-repository onto the release path

Returns:

  • void

Raises:

  • (NotImplementedError) 


64
65
66
67
68
 
# File 'lib/capistrano/bundle_rsync/scm.rb', line 64

def create_release
  raise NotImplementedError.new(
    "Your SCM strategy module should provide a #create_release method"
  )
end

#rsync_release ⇒ Object

This method is abstract.

Rsync the contents of the release path

This is an additional task endpoint provided by capistrano-bundle_rsync

Returns:

  • void

Raises:

  • (NotImplementedError) 


90
91
92
93
94
 
# File 'lib/capistrano/bundle_rsync/scm.rb', line 90

def rsync_release
  raise NotImplementedError.new(
    "Your SCM strategy module should provide a #rsync_release method"
  )
end

#rsync_shared ⇒ Object

This method is abstract.

Rsync arbitrary contents to shared directory

This is an additional task endpoint provided by capistrano-bundle_rsync

Returns:

  • void



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/capistrano/bundle_rsync/scm.rb', line 103

def rsync_shared
  hosts = ::Capistrano::Configuration.env.filter(release_roles(:all))
  rsync_options = config.rsync_options

  if config_files = config.config_files
    Parallel.each(hosts, in_threads: config.max_parallels(hosts)) do |host|
      ssh = config.build_ssh_command(host)
      config_files.each do |config_file|
        basename = File.basename(config_file)
        execute :rsync, "#{rsync_options} --rsh='#{ssh}' #{config_file} #{host}:#{release_path}/config/#{basename}"
      end
    end
  end

  if shared_dirs = config.shared_dirs
    Parallel.each(hosts, in_threads: config.max_parallels(hosts)) do |host|
      ssh = config.build_ssh_command(host)
      shared_dirs.each do |shared_dir|
        basename = File.basename(shared_dir)
        execute :rsync, "#{rsync_options} --rsh='#{ssh}' #{shared_dir}/ #{host}:#{shared_path}/#{basename}/"
      end
    end
  end
end

#set_current_revision ⇒ Object

This method is abstract.

Identify the SHA of the commit that will be deployed. This will most likely involve SshKit’s capture method.

Returns:

  • void

Raises:

  • (NotImplementedError) 


134
135
136
137
138
 
# File 'lib/capistrano/bundle_rsync/scm.rb', line 134

def set_current_revision
  raise NotImplementedError.new(
    "Your SCM strategy module should provide a #set_current_revision method"
  )
end

#test ⇒ Boolean

This method is abstract.

Your implementation should check the existence of a cache repository on the deployment target

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


15
16
17
18
19
 
# File 'lib/capistrano/bundle_rsync/scm.rb', line 15

def test
  raise NotImplementedError.new(
    "Your SCM strategy module should provide a #test method"
  )
end

#update ⇒ Object

This method is abstract.

Update the clone on the deployment target

Returns:

  • void

Raises:

  • (NotImplementedError) 


52
53
54
55
56
 
# File 'lib/capistrano/bundle_rsync/scm.rb', line 52

def update
  raise NotImplementedError.new(
    "Your SCM strategy module should provide a #update method"
  )
end