Class: Pantograph::Actions::RsyncAction

Inherits:
Pantograph::Action show all
Defined in:
pantograph/lib/pantograph/actions/rsync.rb

Constant Summary

Constants inherited from Pantograph::Action

Pantograph::Action::AVAILABLE_CATEGORIES, Pantograph::Action::RETURN_TYPES

Documentation collapse

Class Method Summary collapse

Methods inherited from Pantograph::Action

action_name, author, deprecated_notes, lane_context, method_missing, other_action, output, return_type, return_value, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.authors ⇒ Object 



52
53
54
 
# File 'pantograph/lib/pantograph/actions/rsync.rb', line 52

def self.authors
  ['hjanuschka']
end

.available_options ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'pantograph/lib/pantograph/actions/rsync.rb', line 28

def self.available_options
  [
    PantographCore::ConfigItem.new(key: :extra,
                                 short_option: '-X',
                                 env_name: 'RSYNC_EXTRA', # The name of the environment variable
                                 description: 'Port', # a short description of this parameter
                                 optional: true,
                                 default_value: '-av',
                                 type: String),
    PantographCore::ConfigItem.new(key: :source,
                                 short_option: '-S',
                                 env_name: 'RSYNC_SRC', # The name of the environment variable
                                 description: 'source file/folder', # a short description of this parameter
                                 optional: false,
                                 type: String),
    PantographCore::ConfigItem.new(key: :destination,
                                 short_option: '-D',
                                 env_name: 'RSYNC_DST', # The name of the environment variable
                                 description: 'destination file/folder', # a short description of this parameter
                                 optional: false,
                                 type: String)
  ]
end

.category ⇒ Object 



69
70
71
 
# File 'pantograph/lib/pantograph/actions/rsync.rb', line 69

def self.category
  :misc
end

.description ⇒ Object 



20
21
22
 
# File 'pantograph/lib/pantograph/actions/rsync.rb', line 20

def self.description
  'Rsync files from :source to :destination'
end

.details ⇒ Object 



24
25
26
 
# File 'pantograph/lib/pantograph/actions/rsync.rb', line 24

def self.details
  'A wrapper around `rsync`, which is a tool that lets you synchronize files, including permissions and so on. For a more detailed information about `rsync`, please see [rsync(1) man page](https://linux.die.net/man/1/rsync).'
end

.example_code ⇒ Object 



60
61
62
63
64
65
66
67
 
# File 'pantograph/lib/pantograph/actions/rsync.rb', line 60

def self.example_code
  [
    'rsync(
      source: "root@host:/tmp/1.txt",
      destination: "/tmp/local_file.txt"
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:



56
57
58
 
# File 'pantograph/lib/pantograph/actions/rsync.rb', line 56

def self.is_supported?(platform)
  true
end

.run(params) ⇒ Object 



8
9
10
11
12
13
14
 
# File 'pantograph/lib/pantograph/actions/rsync.rb', line 8

def self.run(params)
  rsync_cmd = ['rsync']
  rsync_cmd << params[:extra]
  rsync_cmd << params[:source]
  rsync_cmd << params[:destination]
  Actions.sh(rsync_cmd.join(" "))
end