nucleon 0.1.19 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -0
- data/Gemfile.lock +1 -0
- data/TODO.rdoc +0 -3
- data/VERSION +1 -1
- data/bin/nucleon +19 -0
- data/lib/core/config.rb +11 -7
- data/lib/core/environment.rb +338 -0
- data/lib/core/facade.rb +150 -98
- data/lib/core/manager.rb +160 -249
- data/lib/core/mixin/action/project.rb +2 -2
- data/lib/core/mixin/macro/plugin_interface.rb +11 -11
- data/lib/core/plugin/action.rb +277 -24
- data/lib/core/plugin/base.rb +22 -14
- data/lib/core/plugin/command.rb +1 -1
- data/lib/core/plugin/event.rb +3 -3
- data/lib/core/plugin/extension.rb +1 -1
- data/lib/core/plugin/project.rb +15 -15
- data/lib/core/plugin/template.rb +1 -1
- data/lib/core/plugin/translator.rb +1 -1
- data/lib/core/util/cache.rb +1 -1
- data/lib/core/util/cli.rb +32 -3
- data/lib/core/util/console.rb +30 -10
- data/lib/core/util/data.rb +11 -3
- data/lib/core/util/logger.rb +1 -1
- data/lib/core/util/shell.rb +6 -3
- data/lib/core/util/ssh.rb +148 -24
- data/lib/nucleon/action/extract.rb +11 -4
- data/lib/nucleon/action/{add.rb → project/add.rb} +13 -4
- data/lib/nucleon/action/{create.rb → project/create.rb} +12 -3
- data/lib/nucleon/action/{remove.rb → project/remove.rb} +11 -2
- data/lib/nucleon/action/{save.rb → project/save.rb} +11 -2
- data/lib/nucleon/action/{update.rb → project/update.rb} +11 -2
- data/lib/nucleon/command/bash.rb +1 -1
- data/lib/nucleon/event/regex.rb +1 -1
- data/lib/nucleon/project/git.rb +3 -3
- data/lib/nucleon/template/{json.rb → JSON.rb} +1 -1
- data/lib/nucleon/template/{yaml.rb → YAML.rb} +1 -1
- data/lib/nucleon/template/wrapper.rb +1 -1
- data/lib/nucleon/translator/{json.rb → JSON.rb} +1 -1
- data/lib/nucleon/translator/{yaml.rb → YAML.rb} +1 -1
- data/lib/nucleon_base.rb +26 -15
- data/locales/en.yml +69 -44
- data/nucleon.gemspec +129 -11
- data/rdoc/site/0.1.19/ARCHITECTURE_rdoc.html +634 -0
- data/rdoc/site/0.1.19/Hash.html +347 -0
- data/rdoc/site/0.1.19/Kernel.html +413 -0
- data/rdoc/site/0.1.19/Nucleon.html +570 -0
- data/rdoc/site/0.1.19/Nucleon/Action.html +280 -0
- data/rdoc/site/0.1.19/Nucleon/Action/Add.html +458 -0
- data/rdoc/site/0.1.19/Nucleon/Action/Create.html +415 -0
- data/rdoc/site/0.1.19/Nucleon/Action/Extract.html +413 -0
- data/rdoc/site/0.1.19/Nucleon/Action/Remove.html +461 -0
- data/rdoc/site/0.1.19/Nucleon/Action/Save.html +434 -0
- data/rdoc/site/0.1.19/Nucleon/Action/Update.html +381 -0
- data/rdoc/site/0.1.19/Nucleon/Codes.html +563 -0
- data/rdoc/site/0.1.19/Nucleon/Command.html +275 -0
- data/rdoc/site/0.1.19/Nucleon/Command/Bash.html +544 -0
- data/rdoc/site/0.1.19/Nucleon/Config.html +1623 -0
- data/rdoc/site/0.1.19/Nucleon/Config/Collection.html +509 -0
- data/rdoc/site/0.1.19/Nucleon/Config/Options.html +489 -0
- data/rdoc/site/0.1.19/Nucleon/Core.html +635 -0
- data/rdoc/site/0.1.19/Nucleon/Errors.html +275 -0
- data/rdoc/site/0.1.19/Nucleon/Errors/BatchError.html +281 -0
- data/rdoc/site/0.1.19/Nucleon/Errors/NucleonError.html +657 -0
- data/rdoc/site/0.1.19/Nucleon/Errors/SSHUnavailable.html +281 -0
- data/rdoc/site/0.1.19/Nucleon/Event.html +275 -0
- data/rdoc/site/0.1.19/Nucleon/Event/Regex.html +467 -0
- data/rdoc/site/0.1.19/Nucleon/Facade.html +2336 -0
- data/rdoc/site/0.1.19/Nucleon/Gems.html +635 -0
- data/rdoc/site/0.1.19/Nucleon/Manager.html +1828 -0
- data/rdoc/site/0.1.19/Nucleon/Mixin.html +284 -0
- data/rdoc/site/0.1.19/Nucleon/Mixin/Action.html +277 -0
- data/rdoc/site/0.1.19/Nucleon/Mixin/Action/Commit.html +381 -0
- data/rdoc/site/0.1.19/Nucleon/Mixin/Action/Project.html +395 -0
- data/rdoc/site/0.1.19/Nucleon/Mixin/Action/Push.html +371 -0
- data/rdoc/site/0.1.19/Nucleon/Mixin/Colors.html +545 -0
- data/rdoc/site/0.1.19/Nucleon/Mixin/ConfigCollection.html +481 -0
- data/rdoc/site/0.1.19/Nucleon/Mixin/ConfigOptions.html +449 -0
- data/rdoc/site/0.1.19/Nucleon/Mixin/Macro.html +276 -0
- data/rdoc/site/0.1.19/Nucleon/Mixin/Macro/ObjectInterface.html +695 -0
- data/rdoc/site/0.1.19/Nucleon/Mixin/Macro/PluginInterface.html +682 -0
- data/rdoc/site/0.1.19/Nucleon/Mixin/Settings.html +481 -0
- data/rdoc/site/0.1.19/Nucleon/Mixin/SubConfig.html +887 -0
- data/rdoc/site/0.1.19/Nucleon/Parallel.html +325 -0
- data/rdoc/site/0.1.19/Nucleon/Parallel/ClassMethods.html +325 -0
- data/rdoc/site/0.1.19/Nucleon/Parallel/InstanceMethods.html +334 -0
- data/rdoc/site/0.1.19/Nucleon/Plugin.html +282 -0
- data/rdoc/site/0.1.19/Nucleon/Plugin/Action.html +1368 -0
- data/rdoc/site/0.1.19/Nucleon/Plugin/Action/Option.html +459 -0
- data/rdoc/site/0.1.19/Nucleon/Plugin/Base.html +1737 -0
- data/rdoc/site/0.1.19/Nucleon/Plugin/Command.html +721 -0
- data/rdoc/site/0.1.19/Nucleon/Plugin/Event.html +442 -0
- data/rdoc/site/0.1.19/Nucleon/Plugin/Extension.html +281 -0
- data/rdoc/site/0.1.19/Nucleon/Plugin/Project.html +2864 -0
- data/rdoc/site/0.1.19/Nucleon/Plugin/Template.html +476 -0
- data/rdoc/site/0.1.19/Nucleon/Plugin/Translator.html +371 -0
- data/rdoc/site/0.1.19/Nucleon/Project.html +276 -0
- data/rdoc/site/0.1.19/Nucleon/Project/Git.html +1801 -0
- data/rdoc/site/0.1.19/Nucleon/Project/Github.html +549 -0
- data/rdoc/site/0.1.19/Nucleon/Template.html +277 -0
- data/rdoc/site/0.1.19/Nucleon/Template/Json.html +329 -0
- data/rdoc/site/0.1.19/Nucleon/Template/Wrapper.html +329 -0
- data/rdoc/site/0.1.19/Nucleon/Template/Yaml.html +329 -0
- data/rdoc/site/0.1.19/Nucleon/Translator.html +276 -0
- data/rdoc/site/0.1.19/Nucleon/Translator/Json.html +366 -0
- data/rdoc/site/0.1.19/Nucleon/Translator/Yaml.html +366 -0
- data/rdoc/site/0.1.19/Nucleon/Util.html +285 -0
- data/rdoc/site/0.1.19/Nucleon/Util/CLI.html +388 -0
- data/rdoc/site/0.1.19/Nucleon/Util/CLI/Parser.html +1183 -0
- data/rdoc/site/0.1.19/Nucleon/Util/Cache.html +780 -0
- data/rdoc/site/0.1.19/Nucleon/Util/Console.html +1294 -0
- data/rdoc/site/0.1.19/Nucleon/Util/Data.html +1399 -0
- data/rdoc/site/0.1.19/Nucleon/Util/Disk.html +522 -0
- data/rdoc/site/0.1.19/Nucleon/Util/Git.html +361 -0
- data/rdoc/site/0.1.19/Nucleon/Util/Liquid.html +365 -0
- data/rdoc/site/0.1.19/Nucleon/Util/Logger.html +806 -0
- data/rdoc/site/0.1.19/Nucleon/Util/Package.html +558 -0
- data/rdoc/site/0.1.19/Nucleon/Util/SSH.html +910 -0
- data/rdoc/site/0.1.19/Nucleon/Util/SSH/Keypair.html +453 -0
- data/rdoc/site/0.1.19/Nucleon/Util/Shell.html +686 -0
- data/rdoc/site/0.1.19/Nucleon/Util/Shell/Result.html +497 -0
- data/rdoc/site/0.1.19/README_rdoc.html +312 -0
- data/rdoc/site/0.1.19/TODO_rdoc.html +267 -0
- data/rdoc/site/0.1.19/created.rid +60 -0
- data/rdoc/site/0.1.19/images/add.png +0 -0
- data/rdoc/site/0.1.19/images/brick.png +0 -0
- data/rdoc/site/0.1.19/images/brick_link.png +0 -0
- data/rdoc/site/0.1.19/images/bug.png +0 -0
- data/rdoc/site/0.1.19/images/bullet_black.png +0 -0
- data/rdoc/site/0.1.19/images/bullet_toggle_minus.png +0 -0
- data/rdoc/site/0.1.19/images/bullet_toggle_plus.png +0 -0
- data/rdoc/site/0.1.19/images/date.png +0 -0
- data/rdoc/site/0.1.19/images/delete.png +0 -0
- data/rdoc/site/0.1.19/images/find.png +0 -0
- data/rdoc/site/0.1.19/images/loadingAnimation.gif +0 -0
- data/rdoc/site/0.1.19/images/macFFBgHack.png +0 -0
- data/rdoc/site/0.1.19/images/package.png +0 -0
- data/rdoc/site/0.1.19/images/page_green.png +0 -0
- data/rdoc/site/0.1.19/images/page_white_text.png +0 -0
- data/rdoc/site/0.1.19/images/page_white_width.png +0 -0
- data/rdoc/site/0.1.19/images/plugin.png +0 -0
- data/rdoc/site/0.1.19/images/ruby.png +0 -0
- data/rdoc/site/0.1.19/images/tag_blue.png +0 -0
- data/rdoc/site/0.1.19/images/tag_green.png +0 -0
- data/rdoc/site/0.1.19/images/transparent.png +0 -0
- data/rdoc/site/0.1.19/images/wrench.png +0 -0
- data/rdoc/site/0.1.19/images/wrench_orange.png +0 -0
- data/rdoc/site/0.1.19/images/zoom.png +0 -0
- data/rdoc/site/0.1.19/index.html +311 -0
- data/rdoc/site/0.1.19/js/darkfish.js +155 -0
- data/rdoc/site/0.1.19/js/jquery.js +18 -0
- data/rdoc/site/0.1.19/js/navigation.js +142 -0
- data/rdoc/site/0.1.19/js/search.js +94 -0
- data/rdoc/site/0.1.19/js/search_index.js +1 -0
- data/rdoc/site/0.1.19/js/searcher.js +228 -0
- data/rdoc/site/0.1.19/rdoc.css +543 -0
- data/rdoc/site/0.1.19/table_of_contents.html +1541 -0
- metadata +140 -11
|
@@ -0,0 +1,910 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
6
|
+
|
|
7
|
+
<title>class Nucleon::Util::SSH - nucleon 0.1.19</title>
|
|
8
|
+
|
|
9
|
+
<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet">
|
|
10
|
+
|
|
11
|
+
<script type="text/javascript">
|
|
12
|
+
var rdoc_rel_prefix = "../../";
|
|
13
|
+
</script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
16
|
+
<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script>
|
|
17
|
+
<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script>
|
|
18
|
+
<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script>
|
|
19
|
+
<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script>
|
|
20
|
+
<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<body id="top" class="class">
|
|
24
|
+
<nav id="metadata">
|
|
25
|
+
<nav id="home-section" class="section">
|
|
26
|
+
<h3 class="section-header">
|
|
27
|
+
<a href="../../index.html">Home</a>
|
|
28
|
+
<a href="../../table_of_contents.html#classes">Classes</a>
|
|
29
|
+
<a href="../../table_of_contents.html#methods">Methods</a>
|
|
30
|
+
</h3>
|
|
31
|
+
</nav>
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
36
|
+
<h3 class="section-header">
|
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
39
|
+
</h3>
|
|
40
|
+
</form>
|
|
41
|
+
|
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
|
43
|
+
</nav>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<div id="file-metadata">
|
|
47
|
+
<nav id="file-list-section" class="section">
|
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
|
49
|
+
<ul>
|
|
50
|
+
<li>lib/core/util/ssh.rb
|
|
51
|
+
</ul>
|
|
52
|
+
</nav>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
<div id="class-metadata">
|
|
58
|
+
|
|
59
|
+
<nav id="parent-class-section" class="section">
|
|
60
|
+
<h3 class="section-header">Parent</h3>
|
|
61
|
+
|
|
62
|
+
<p class="link"><a href="../Core.html">Nucleon::Core</a>
|
|
63
|
+
|
|
64
|
+
</nav>
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
<!-- Method Quickref -->
|
|
68
|
+
<nav id="method-list-section" class="section">
|
|
69
|
+
<h3 class="section-header">Methods</h3>
|
|
70
|
+
|
|
71
|
+
<ul class="link-list">
|
|
72
|
+
|
|
73
|
+
<li><a href="#method-c-close">::close</a>
|
|
74
|
+
|
|
75
|
+
<li><a href="#method-c-close_session">::close_session</a>
|
|
76
|
+
|
|
77
|
+
<li><a href="#method-c-download">::download</a>
|
|
78
|
+
|
|
79
|
+
<li><a href="#method-c-exec">::exec</a>
|
|
80
|
+
|
|
81
|
+
<li><a href="#method-c-generate">::generate</a>
|
|
82
|
+
|
|
83
|
+
<li><a href="#method-c-init_session">::init_session</a>
|
|
84
|
+
|
|
85
|
+
<li><a href="#method-c-key_path">::key_path</a>
|
|
86
|
+
|
|
87
|
+
<li><a href="#method-c-session">::session</a>
|
|
88
|
+
|
|
89
|
+
<li><a href="#method-c-session_id">::session_id</a>
|
|
90
|
+
|
|
91
|
+
<li><a href="#method-c-terminal">::terminal</a>
|
|
92
|
+
|
|
93
|
+
<li><a href="#method-c-upload">::upload</a>
|
|
94
|
+
|
|
95
|
+
<li><a href="#method-c-valid-3F">::valid?</a>
|
|
96
|
+
|
|
97
|
+
</ul>
|
|
98
|
+
</nav>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<div id="project-metadata">
|
|
103
|
+
<nav id="fileindex-section" class="section project-section">
|
|
104
|
+
<h3 class="section-header">Pages</h3>
|
|
105
|
+
|
|
106
|
+
<ul>
|
|
107
|
+
|
|
108
|
+
<li class="file"><a href="../../ARCHITECTURE_rdoc.html">ARCHITECTURE</a>
|
|
109
|
+
|
|
110
|
+
<li class="file"><a href="../../README_rdoc.html">README</a>
|
|
111
|
+
|
|
112
|
+
<li class="file"><a href="../../TODO_rdoc.html">TODO</a>
|
|
113
|
+
|
|
114
|
+
</ul>
|
|
115
|
+
</nav>
|
|
116
|
+
|
|
117
|
+
<nav id="classindex-section" class="section project-section">
|
|
118
|
+
<h3 class="section-header">Class and Module Index</h3>
|
|
119
|
+
|
|
120
|
+
<ul class="link-list">
|
|
121
|
+
|
|
122
|
+
<li><a href="../../Nucleon.html">Nucleon</a>
|
|
123
|
+
|
|
124
|
+
<li><a href="../../Nucleon/Action.html">Nucleon::Action</a>
|
|
125
|
+
|
|
126
|
+
<li><a href="../../Nucleon/Action/Add.html">Nucleon::Action::Add</a>
|
|
127
|
+
|
|
128
|
+
<li><a href="../../Nucleon/Action/Create.html">Nucleon::Action::Create</a>
|
|
129
|
+
|
|
130
|
+
<li><a href="../../Nucleon/Action/Extract.html">Nucleon::Action::Extract</a>
|
|
131
|
+
|
|
132
|
+
<li><a href="../../Nucleon/Action/Remove.html">Nucleon::Action::Remove</a>
|
|
133
|
+
|
|
134
|
+
<li><a href="../../Nucleon/Action/Save.html">Nucleon::Action::Save</a>
|
|
135
|
+
|
|
136
|
+
<li><a href="../../Nucleon/Action/Update.html">Nucleon::Action::Update</a>
|
|
137
|
+
|
|
138
|
+
<li><a href="../../Nucleon/Codes.html">Nucleon::Codes</a>
|
|
139
|
+
|
|
140
|
+
<li><a href="../../Nucleon/Command.html">Nucleon::Command</a>
|
|
141
|
+
|
|
142
|
+
<li><a href="../../Nucleon/Command/Bash.html">Nucleon::Command::Bash</a>
|
|
143
|
+
|
|
144
|
+
<li><a href="../../Nucleon/Config.html">Nucleon::Config</a>
|
|
145
|
+
|
|
146
|
+
<li><a href="../../Nucleon/Config/Collection.html">Nucleon::Config::Collection</a>
|
|
147
|
+
|
|
148
|
+
<li><a href="../../Nucleon/Config/Options.html">Nucleon::Config::Options</a>
|
|
149
|
+
|
|
150
|
+
<li><a href="../../Nucleon/Core.html">Nucleon::Core</a>
|
|
151
|
+
|
|
152
|
+
<li><a href="../../Nucleon/Errors.html">Nucleon::Errors</a>
|
|
153
|
+
|
|
154
|
+
<li><a href="../../Nucleon/Errors/BatchError.html">Nucleon::Errors::BatchError</a>
|
|
155
|
+
|
|
156
|
+
<li><a href="../../Nucleon/Errors/NucleonError.html">Nucleon::Errors::NucleonError</a>
|
|
157
|
+
|
|
158
|
+
<li><a href="../../Nucleon/Errors/SSHUnavailable.html">Nucleon::Errors::SSHUnavailable</a>
|
|
159
|
+
|
|
160
|
+
<li><a href="../../Nucleon/Event.html">Nucleon::Event</a>
|
|
161
|
+
|
|
162
|
+
<li><a href="../../Nucleon/Event/Regex.html">Nucleon::Event::Regex</a>
|
|
163
|
+
|
|
164
|
+
<li><a href="../../Nucleon/Facade.html">Nucleon::Facade</a>
|
|
165
|
+
|
|
166
|
+
<li><a href="../../Nucleon/Gems.html">Nucleon::Gems</a>
|
|
167
|
+
|
|
168
|
+
<li><a href="../../Nucleon/Manager.html">Nucleon::Manager</a>
|
|
169
|
+
|
|
170
|
+
<li><a href="../../Nucleon/Mixin.html">Nucleon::Mixin</a>
|
|
171
|
+
|
|
172
|
+
<li><a href="../../Nucleon/Mixin/Action.html">Nucleon::Mixin::Action</a>
|
|
173
|
+
|
|
174
|
+
<li><a href="../../Nucleon/Mixin/Action/Commit.html">Nucleon::Mixin::Action::Commit</a>
|
|
175
|
+
|
|
176
|
+
<li><a href="../../Nucleon/Mixin/Action/Project.html">Nucleon::Mixin::Action::Project</a>
|
|
177
|
+
|
|
178
|
+
<li><a href="../../Nucleon/Mixin/Action/Push.html">Nucleon::Mixin::Action::Push</a>
|
|
179
|
+
|
|
180
|
+
<li><a href="../../Nucleon/Mixin/Colors.html">Nucleon::Mixin::Colors</a>
|
|
181
|
+
|
|
182
|
+
<li><a href="../../Nucleon/Mixin/ConfigCollection.html">Nucleon::Mixin::ConfigCollection</a>
|
|
183
|
+
|
|
184
|
+
<li><a href="../../Nucleon/Mixin/ConfigOptions.html">Nucleon::Mixin::ConfigOptions</a>
|
|
185
|
+
|
|
186
|
+
<li><a href="../../Nucleon/Mixin/Macro.html">Nucleon::Mixin::Macro</a>
|
|
187
|
+
|
|
188
|
+
<li><a href="../../Nucleon/Mixin/Macro/ObjectInterface.html">Nucleon::Mixin::Macro::ObjectInterface</a>
|
|
189
|
+
|
|
190
|
+
<li><a href="../../Nucleon/Mixin/Macro/PluginInterface.html">Nucleon::Mixin::Macro::PluginInterface</a>
|
|
191
|
+
|
|
192
|
+
<li><a href="../../Nucleon/Mixin/Settings.html">Nucleon::Mixin::Settings</a>
|
|
193
|
+
|
|
194
|
+
<li><a href="../../Nucleon/Mixin/SubConfig.html">Nucleon::Mixin::SubConfig</a>
|
|
195
|
+
|
|
196
|
+
<li><a href="../../Nucleon/Parallel.html">Nucleon::Parallel</a>
|
|
197
|
+
|
|
198
|
+
<li><a href="../../Nucleon/Parallel/ClassMethods.html">Nucleon::Parallel::ClassMethods</a>
|
|
199
|
+
|
|
200
|
+
<li><a href="../../Nucleon/Parallel/InstanceMethods.html">Nucleon::Parallel::InstanceMethods</a>
|
|
201
|
+
|
|
202
|
+
<li><a href="../../Nucleon/Plugin.html">Nucleon::Plugin</a>
|
|
203
|
+
|
|
204
|
+
<li><a href="../../Nucleon/Plugin/Action.html">Nucleon::Plugin::Action</a>
|
|
205
|
+
|
|
206
|
+
<li><a href="../../Nucleon/Plugin/Action/Option.html">Nucleon::Plugin::Action::Option</a>
|
|
207
|
+
|
|
208
|
+
<li><a href="../../Nucleon/Plugin/Base.html">Nucleon::Plugin::Base</a>
|
|
209
|
+
|
|
210
|
+
<li><a href="../../Nucleon/Plugin/Command.html">Nucleon::Plugin::Command</a>
|
|
211
|
+
|
|
212
|
+
<li><a href="../../Nucleon/Plugin/Event.html">Nucleon::Plugin::Event</a>
|
|
213
|
+
|
|
214
|
+
<li><a href="../../Nucleon/Plugin/Extension.html">Nucleon::Plugin::Extension</a>
|
|
215
|
+
|
|
216
|
+
<li><a href="../../Nucleon/Plugin/Project.html">Nucleon::Plugin::Project</a>
|
|
217
|
+
|
|
218
|
+
<li><a href="../../Nucleon/Plugin/Template.html">Nucleon::Plugin::Template</a>
|
|
219
|
+
|
|
220
|
+
<li><a href="../../Nucleon/Plugin/Translator.html">Nucleon::Plugin::Translator</a>
|
|
221
|
+
|
|
222
|
+
<li><a href="../../Nucleon/Project.html">Nucleon::Project</a>
|
|
223
|
+
|
|
224
|
+
<li><a href="../../Nucleon/Project/Git.html">Nucleon::Project::Git</a>
|
|
225
|
+
|
|
226
|
+
<li><a href="../../Nucleon/Project/Github.html">Nucleon::Project::Github</a>
|
|
227
|
+
|
|
228
|
+
<li><a href="../../Nucleon/Template.html">Nucleon::Template</a>
|
|
229
|
+
|
|
230
|
+
<li><a href="../../Nucleon/Template/Json.html">Nucleon::Template::Json</a>
|
|
231
|
+
|
|
232
|
+
<li><a href="../../Nucleon/Template/Wrapper.html">Nucleon::Template::Wrapper</a>
|
|
233
|
+
|
|
234
|
+
<li><a href="../../Nucleon/Template/Yaml.html">Nucleon::Template::Yaml</a>
|
|
235
|
+
|
|
236
|
+
<li><a href="../../Nucleon/Translator.html">Nucleon::Translator</a>
|
|
237
|
+
|
|
238
|
+
<li><a href="../../Nucleon/Translator/Json.html">Nucleon::Translator::Json</a>
|
|
239
|
+
|
|
240
|
+
<li><a href="../../Nucleon/Translator/Yaml.html">Nucleon::Translator::Yaml</a>
|
|
241
|
+
|
|
242
|
+
<li><a href="../../Nucleon/Util.html">Nucleon::Util</a>
|
|
243
|
+
|
|
244
|
+
<li><a href="../../Nucleon/Util/CLI.html">Nucleon::Util::CLI</a>
|
|
245
|
+
|
|
246
|
+
<li><a href="../../Nucleon/Util/CLI/Parser.html">Nucleon::Util::CLI::Parser</a>
|
|
247
|
+
|
|
248
|
+
<li><a href="../../Nucleon/Util/Cache.html">Nucleon::Util::Cache</a>
|
|
249
|
+
|
|
250
|
+
<li><a href="../../Nucleon/Util/Console.html">Nucleon::Util::Console</a>
|
|
251
|
+
|
|
252
|
+
<li><a href="../../Nucleon/Util/Data.html">Nucleon::Util::Data</a>
|
|
253
|
+
|
|
254
|
+
<li><a href="../../Nucleon/Util/Disk.html">Nucleon::Util::Disk</a>
|
|
255
|
+
|
|
256
|
+
<li><a href="../../Nucleon/Util/Git.html">Nucleon::Util::Git</a>
|
|
257
|
+
|
|
258
|
+
<li><a href="../../Nucleon/Util/Liquid.html">Nucleon::Util::Liquid</a>
|
|
259
|
+
|
|
260
|
+
<li><a href="../../Nucleon/Util/Logger.html">Nucleon::Util::Logger</a>
|
|
261
|
+
|
|
262
|
+
<li><a href="../../Nucleon/Util/Package.html">Nucleon::Util::Package</a>
|
|
263
|
+
|
|
264
|
+
<li><a href="../../Nucleon/Util/SSH.html">Nucleon::Util::SSH</a>
|
|
265
|
+
|
|
266
|
+
<li><a href="../../Nucleon/Util/SSH/Keypair.html">Nucleon::Util::SSH::Keypair</a>
|
|
267
|
+
|
|
268
|
+
<li><a href="../../Nucleon/Util/Shell.html">Nucleon::Util::Shell</a>
|
|
269
|
+
|
|
270
|
+
<li><a href="../../Nucleon/Util/Shell/Result.html">Nucleon::Util::Shell::Result</a>
|
|
271
|
+
|
|
272
|
+
<li><a href="../../Hash.html">Hash</a>
|
|
273
|
+
|
|
274
|
+
<li><a href="../../Kernel.html">Kernel</a>
|
|
275
|
+
|
|
276
|
+
</ul>
|
|
277
|
+
</nav>
|
|
278
|
+
|
|
279
|
+
</div>
|
|
280
|
+
</nav>
|
|
281
|
+
|
|
282
|
+
<div id="documentation">
|
|
283
|
+
<h1 class="class">class Nucleon::Util::SSH</h1>
|
|
284
|
+
|
|
285
|
+
<div id="description" class="description">
|
|
286
|
+
|
|
287
|
+
</div><!-- description -->
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<!-- Methods -->
|
|
302
|
+
|
|
303
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
|
304
|
+
<h3 class="section-header">Public Class Methods</h3>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
<div id="method-c-close" class="method-detail ">
|
|
308
|
+
|
|
309
|
+
<div class="method-heading">
|
|
310
|
+
<span class="method-name">close</span><span
|
|
311
|
+
class="method-args">(hostname = nil, user = nil)</span>
|
|
312
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
313
|
+
</div>
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
<div class="method-description">
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
<div class="method-source-code" id="close-source">
|
|
323
|
+
<pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 157</span>
|
|
324
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">close</span>(<span class="ruby-identifier">hostname</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">user</span> = <span class="ruby-keyword">nil</span>)
|
|
325
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">hostname</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">user</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-comment"># Assume we entered a session id</span>
|
|
326
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">hostname</span>)
|
|
327
|
+
<span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">hostname</span>].<span class="ruby-identifier">close</span>
|
|
328
|
+
<span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">hostname</span>)
|
|
329
|
+
<span class="ruby-keyword">end</span>
|
|
330
|
+
|
|
331
|
+
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">hostname</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">user</span> <span class="ruby-comment"># Generate session id from args</span>
|
|
332
|
+
<span class="ruby-identifier">session_id</span> = <span class="ruby-identifier">session_id</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>)
|
|
333
|
+
|
|
334
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">session_id</span>)
|
|
335
|
+
<span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">session_id</span>].<span class="ruby-identifier">close</span>
|
|
336
|
+
<span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">session_id</span>)
|
|
337
|
+
<span class="ruby-keyword">end</span>
|
|
338
|
+
|
|
339
|
+
<span class="ruby-keyword">else</span> <span class="ruby-comment"># Close all connections</span>
|
|
340
|
+
<span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">id</span><span class="ruby-operator">|</span>
|
|
341
|
+
<span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">id</span>].<span class="ruby-identifier">close</span>
|
|
342
|
+
<span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">id</span>)
|
|
343
|
+
<span class="ruby-keyword">end</span>
|
|
344
|
+
<span class="ruby-keyword">end</span>
|
|
345
|
+
<span class="ruby-keyword">end</span></pre>
|
|
346
|
+
</div><!-- close-source -->
|
|
347
|
+
|
|
348
|
+
</div>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
</div><!-- close-method -->
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
<div id="method-c-close_session" class="method-detail ">
|
|
357
|
+
|
|
358
|
+
<div class="method-heading">
|
|
359
|
+
<span class="method-name">close_session</span><span
|
|
360
|
+
class="method-args">(hostname, user)</span>
|
|
361
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
362
|
+
</div>
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
<div class="method-description">
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
<div class="method-source-code" id="close_session-source">
|
|
372
|
+
<pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 143</span>
|
|
373
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">close_session</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>)
|
|
374
|
+
<span class="ruby-identifier">session_id</span> = <span class="ruby-identifier">session_id</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>)
|
|
375
|
+
|
|
376
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">session_id</span>)
|
|
377
|
+
<span class="ruby-keyword">begin</span> <span class="ruby-comment"># Don't care about errors here</span>
|
|
378
|
+
<span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">session_id</span>].<span class="ruby-identifier">close</span>
|
|
379
|
+
<span class="ruby-keyword">rescue</span>
|
|
380
|
+
<span class="ruby-keyword">end</span>
|
|
381
|
+
<span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">session_id</span>)
|
|
382
|
+
<span class="ruby-keyword">end</span>
|
|
383
|
+
<span class="ruby-keyword">end</span></pre>
|
|
384
|
+
</div><!-- close_session-source -->
|
|
385
|
+
|
|
386
|
+
</div>
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
</div><!-- close_session-method -->
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<div id="method-c-download" class="method-detail ">
|
|
395
|
+
|
|
396
|
+
<div class="method-heading">
|
|
397
|
+
<span class="method-name">download</span><span
|
|
398
|
+
class="method-args">(hostname, user, remote_path, local_path, options = {}) { |name, received, total| ... }</span>
|
|
399
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
400
|
+
</div>
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
<div class="method-description">
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
<div class="method-source-code" id="download-source">
|
|
410
|
+
<pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 233</span>
|
|
411
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">download</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">options</span> = {})
|
|
412
|
+
<span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>)
|
|
413
|
+
|
|
414
|
+
<span class="ruby-identifier">require</span> <span class="ruby-string">'net/scp'</span>
|
|
415
|
+
|
|
416
|
+
<span class="ruby-comment"># Accepted options:</span>
|
|
417
|
+
<span class="ruby-comment"># * :recursive - the +remote+ parameter refers to a remote directory, which</span>
|
|
418
|
+
<span class="ruby-comment"># should be downloaded to a new directory named +local+ on the local</span>
|
|
419
|
+
<span class="ruby-comment"># machine.</span>
|
|
420
|
+
<span class="ruby-comment"># * :preserve - the atime and mtime of the file should be preserved.</span>
|
|
421
|
+
<span class="ruby-comment"># * :verbose - the process should result in verbose output on the server</span>
|
|
422
|
+
<span class="ruby-comment"># end (useful for debugging).</span>
|
|
423
|
+
<span class="ruby-comment">#</span>
|
|
424
|
+
<span class="ruby-identifier">config</span>.<span class="ruby-identifier">init</span>(<span class="ruby-value">:recursive</span>, <span class="ruby-keyword">true</span>)
|
|
425
|
+
<span class="ruby-identifier">config</span>.<span class="ruby-identifier">init</span>(<span class="ruby-value">:preserve</span>, <span class="ruby-keyword">true</span>)
|
|
426
|
+
<span class="ruby-identifier">config</span>.<span class="ruby-identifier">init</span>(<span class="ruby-value">:verbose</span>, <span class="ruby-keyword">true</span>)
|
|
427
|
+
|
|
428
|
+
<span class="ruby-identifier">blocking</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:blocking</span>, <span class="ruby-keyword">true</span>)
|
|
429
|
+
|
|
430
|
+
<span class="ruby-identifier">session</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ssh</span><span class="ruby-operator">|</span>
|
|
431
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">blocking</span>
|
|
432
|
+
<span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">download!</span>(<span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">export</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">received</span>, <span class="ruby-identifier">total</span><span class="ruby-operator">|</span>
|
|
433
|
+
<span class="ruby-keyword">yield</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">received</span>, <span class="ruby-identifier">total</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
|
434
|
+
<span class="ruby-keyword">end</span>
|
|
435
|
+
<span class="ruby-keyword">else</span>
|
|
436
|
+
<span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">download</span>(<span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">export</span>)
|
|
437
|
+
<span class="ruby-keyword">end</span>
|
|
438
|
+
<span class="ruby-keyword">end</span>
|
|
439
|
+
<span class="ruby-keyword">end</span></pre>
|
|
440
|
+
</div><!-- download-source -->
|
|
441
|
+
|
|
442
|
+
</div>
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
</div><!-- download-method -->
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<div id="method-c-exec" class="method-detail ">
|
|
451
|
+
|
|
452
|
+
<div class="method-heading">
|
|
453
|
+
<span class="method-name">exec</span><span
|
|
454
|
+
class="method-args">(hostname, user, commands) { |:output, command, data| ... }</span>
|
|
455
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
456
|
+
</div>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
<div class="method-description">
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
<div class="method-source-code" id="exec-source">
|
|
466
|
+
<pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 182</span>
|
|
467
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">exec</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">commands</span>)
|
|
468
|
+
<span class="ruby-identifier">results</span> = []
|
|
469
|
+
|
|
470
|
+
<span class="ruby-keyword">begin</span>
|
|
471
|
+
<span class="ruby-identifier">session</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ssh</span><span class="ruby-operator">|</span>
|
|
472
|
+
<span class="ruby-constant">Data</span>.<span class="ruby-identifier">array</span>(<span class="ruby-identifier">commands</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">command</span><span class="ruby-operator">|</span>
|
|
473
|
+
<span class="ruby-identifier">command</span> = <span class="ruby-identifier">command</span>.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">' '</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">command</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
|
|
474
|
+
<span class="ruby-identifier">command</span> = <span class="ruby-identifier">command</span>.<span class="ruby-identifier">to_s</span>
|
|
475
|
+
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Shell</span><span class="ruby-operator">::</span><span class="ruby-constant">Result</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">command</span>)
|
|
476
|
+
|
|
477
|
+
<span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">open_channel</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ssh_channel</span><span class="ruby-operator">|</span>
|
|
478
|
+
<span class="ruby-identifier">ssh_channel</span>.<span class="ruby-identifier">request_pty</span>
|
|
479
|
+
<span class="ruby-identifier">ssh_channel</span>.<span class="ruby-identifier">exec</span>(<span class="ruby-identifier">command</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">channel</span>, <span class="ruby-identifier">success</span><span class="ruby-operator">|</span>
|
|
480
|
+
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">success</span>
|
|
481
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-node">"Could not execute command: #{command.inspect}"</span>
|
|
482
|
+
<span class="ruby-keyword">end</span>
|
|
483
|
+
|
|
484
|
+
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_data</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
|
|
485
|
+
<span class="ruby-identifier">result</span>.<span class="ruby-identifier">append_output</span>(<span class="ruby-identifier">data</span>)
|
|
486
|
+
<span class="ruby-keyword">yield</span>(<span class="ruby-value">:output</span>, <span class="ruby-identifier">command</span>, <span class="ruby-identifier">data</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
|
487
|
+
<span class="ruby-keyword">end</span>
|
|
488
|
+
|
|
489
|
+
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_extended_data</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
|
|
490
|
+
<span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
|
|
491
|
+
<span class="ruby-identifier">result</span>.<span class="ruby-identifier">append_errors</span>(<span class="ruby-identifier">data</span>)
|
|
492
|
+
<span class="ruby-keyword">yield</span>(<span class="ruby-value">:error</span>, <span class="ruby-identifier">command</span>, <span class="ruby-identifier">data</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
|
493
|
+
<span class="ruby-keyword">end</span>
|
|
494
|
+
|
|
495
|
+
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_request</span>(<span class="ruby-string">'exit-status'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
|
|
496
|
+
<span class="ruby-identifier">result</span>.<span class="ruby-identifier">status</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">read_long</span>
|
|
497
|
+
<span class="ruby-keyword">end</span>
|
|
498
|
+
|
|
499
|
+
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_request</span>(<span class="ruby-string">'exit-signal'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
|
|
500
|
+
<span class="ruby-identifier">result</span>.<span class="ruby-identifier">status</span> = <span class="ruby-value">255</span>
|
|
501
|
+
<span class="ruby-keyword">end</span>
|
|
502
|
+
<span class="ruby-keyword">end</span>
|
|
503
|
+
<span class="ruby-keyword">end</span>
|
|
504
|
+
<span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">loop</span>
|
|
505
|
+
<span class="ruby-identifier">results</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">result</span>
|
|
506
|
+
<span class="ruby-keyword">end</span>
|
|
507
|
+
<span class="ruby-keyword">end</span>
|
|
508
|
+
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SSH</span><span class="ruby-operator">::</span><span class="ruby-constant">HostKeyMismatch</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">error</span>
|
|
509
|
+
<span class="ruby-identifier">error</span>.<span class="ruby-identifier">remember_host!</span>
|
|
510
|
+
<span class="ruby-identifier">sleep</span> <span class="ruby-value">0.2</span>
|
|
511
|
+
<span class="ruby-keyword">retry</span>
|
|
512
|
+
<span class="ruby-keyword">end</span>
|
|
513
|
+
<span class="ruby-identifier">results</span>
|
|
514
|
+
<span class="ruby-keyword">end</span></pre>
|
|
515
|
+
</div><!-- exec-source -->
|
|
516
|
+
|
|
517
|
+
</div>
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
</div><!-- exec-method -->
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
<div id="method-c-generate" class="method-detail ">
|
|
526
|
+
|
|
527
|
+
<div class="method-heading">
|
|
528
|
+
<span class="method-name">generate</span><span
|
|
529
|
+
class="method-args">(options = {})</span>
|
|
530
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
531
|
+
</div>
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
<div class="method-description">
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
<div class="method-source-code" id="generate-source">
|
|
541
|
+
<pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 26</span>
|
|
542
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">generate</span>(<span class="ruby-identifier">options</span> = {})
|
|
543
|
+
<span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>)
|
|
544
|
+
|
|
545
|
+
<span class="ruby-identifier">private_key</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:private_key</span>, <span class="ruby-keyword">nil</span>)
|
|
546
|
+
<span class="ruby-identifier">original_key</span> = <span class="ruby-keyword">nil</span>
|
|
547
|
+
<span class="ruby-identifier">key_comment</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:comment</span>, <span class="ruby-string">''</span>)
|
|
548
|
+
|
|
549
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">private_key</span>.<span class="ruby-identifier">nil?</span>
|
|
550
|
+
<span class="ruby-identifier">key_type</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:type</span>, <span class="ruby-string">"RSA"</span>)
|
|
551
|
+
<span class="ruby-identifier">key_bits</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:bits</span>, <span class="ruby-value">2048</span>)
|
|
552
|
+
<span class="ruby-identifier">passphrase</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:passphrase</span>, <span class="ruby-keyword">nil</span>)
|
|
553
|
+
|
|
554
|
+
<span class="ruby-identifier">key_data</span> = <span class="ruby-constant">SSHKey</span>.<span class="ruby-identifier">generate</span>(
|
|
555
|
+
<span class="ruby-value">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key_type</span>,
|
|
556
|
+
<span class="ruby-value">:bits</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key_bits</span>,
|
|
557
|
+
<span class="ruby-value">:comment</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key_comment</span>,
|
|
558
|
+
<span class="ruby-value">:passphrase</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">passphrase</span>
|
|
559
|
+
)
|
|
560
|
+
<span class="ruby-identifier">is_new</span> = <span class="ruby-keyword">true</span>
|
|
561
|
+
|
|
562
|
+
<span class="ruby-keyword">else</span>
|
|
563
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">private_key</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">'PRIVATE KEY'</span>)
|
|
564
|
+
<span class="ruby-identifier">original_key</span> = <span class="ruby-identifier">private_key</span>
|
|
565
|
+
<span class="ruby-keyword">else</span>
|
|
566
|
+
<span class="ruby-identifier">original_key</span> = <span class="ruby-constant">Disk</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">private_key</span>)
|
|
567
|
+
<span class="ruby-keyword">end</span>
|
|
568
|
+
|
|
569
|
+
<span class="ruby-identifier">key_data</span> = <span class="ruby-constant">SSHKey</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">original_key</span>, <span class="ruby-value">:comment</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">key_comment</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">original_key</span>
|
|
570
|
+
<span class="ruby-identifier">is_new</span> = <span class="ruby-keyword">false</span>
|
|
571
|
+
<span class="ruby-keyword">end</span>
|
|
572
|
+
|
|
573
|
+
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">key_data</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span> <span class="ruby-identifier">key_data</span>.<span class="ruby-identifier">ssh_public_key</span>.<span class="ruby-identifier">empty?</span>
|
|
574
|
+
<span class="ruby-constant">Keypair</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">key_data</span>, <span class="ruby-identifier">is_new</span>, <span class="ruby-identifier">original_key</span>)
|
|
575
|
+
<span class="ruby-keyword">end</span></pre>
|
|
576
|
+
</div><!-- generate-source -->
|
|
577
|
+
|
|
578
|
+
</div>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
</div><!-- generate-method -->
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
<div id="method-c-init_session" class="method-detail ">
|
|
587
|
+
|
|
588
|
+
<div class="method-heading">
|
|
589
|
+
<span class="method-name">init_session</span><span
|
|
590
|
+
class="method-args">(hostname, user, port = 22, private_key = nil, options = {})</span>
|
|
591
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
592
|
+
</div>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
<div class="method-description">
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
<div class="method-source-code" id="init_session-source">
|
|
602
|
+
<pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 137</span>
|
|
603
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">init_session</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">port</span> = <span class="ruby-value">22</span>, <span class="ruby-identifier">private_key</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span> = {})
|
|
604
|
+
<span class="ruby-identifier">session</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">port</span>, <span class="ruby-identifier">private_key</span>, <span class="ruby-keyword">true</span>, <span class="ruby-identifier">options</span>)
|
|
605
|
+
<span class="ruby-keyword">end</span></pre>
|
|
606
|
+
</div><!-- init_session-source -->
|
|
607
|
+
|
|
608
|
+
</div>
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
</div><!-- init_session-method -->
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
<div id="method-c-key_path" class="method-detail ">
|
|
617
|
+
|
|
618
|
+
<div class="method-heading">
|
|
619
|
+
<span class="method-name">key_path</span><span
|
|
620
|
+
class="method-args">()</span>
|
|
621
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
622
|
+
</div>
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
<div class="method-description">
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
<div class="method-source-code" id="key_path-source">
|
|
632
|
+
<pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 13</span>
|
|
633
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">key_path</span>
|
|
634
|
+
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">@@key_path</span>
|
|
635
|
+
<span class="ruby-identifier">home_path</span> = ( <span class="ruby-constant">ENV</span>[<span class="ruby-string">'USER'</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'root'</span> <span class="ruby-operator">?</span> <span class="ruby-string">'/root'</span> <span class="ruby-operator">:</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">'HOME'</span>] ) <span class="ruby-comment"># In case we are using sudo</span>
|
|
636
|
+
<span class="ruby-identifier">@@key_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">home_path</span>, <span class="ruby-string">'.ssh'</span>)
|
|
637
|
+
|
|
638
|
+
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir</span>(<span class="ruby-identifier">@@key_path</span>) <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">@@key_path</span>)
|
|
639
|
+
<span class="ruby-keyword">end</span>
|
|
640
|
+
<span class="ruby-identifier">@@key_path</span>
|
|
641
|
+
<span class="ruby-keyword">end</span></pre>
|
|
642
|
+
</div><!-- key_path-source -->
|
|
643
|
+
|
|
644
|
+
</div>
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
</div><!-- key_path-method -->
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
<div id="method-c-session" class="method-detail ">
|
|
653
|
+
|
|
654
|
+
<div class="method-heading">
|
|
655
|
+
<span class="method-name">session</span><span
|
|
656
|
+
class="method-args">(hostname, user, port = 22, private_key = nil, reset = false, options = {}) { |sessions| ... }</span>
|
|
657
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
658
|
+
</div>
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
<div class="method-description">
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
<div class="method-source-code" id="session-source">
|
|
668
|
+
<pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 114</span>
|
|
669
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">session</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">port</span> = <span class="ruby-value">22</span>, <span class="ruby-identifier">private_key</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">reset</span> = <span class="ruby-keyword">false</span>, <span class="ruby-identifier">options</span> = {})
|
|
670
|
+
<span class="ruby-identifier">require</span> <span class="ruby-string">'net/ssh'</span>
|
|
671
|
+
|
|
672
|
+
<span class="ruby-identifier">ssh_options</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">new</span>({
|
|
673
|
+
<span class="ruby-value">:user_known_hosts_file</span> =<span class="ruby-operator">></span> [ <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">key_path</span>, <span class="ruby-string">'known_hosts'</span>), <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">key_path</span>, <span class="ruby-string">'known_hosts2'</span>) ],
|
|
674
|
+
<span class="ruby-value">:key_data</span> =<span class="ruby-operator">></span> [],
|
|
675
|
+
<span class="ruby-value">:keys_only</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">false</span>,
|
|
676
|
+
<span class="ruby-value">:auth_methods</span> =<span class="ruby-operator">></span> [ <span class="ruby-string">'publickey'</span> ],
|
|
677
|
+
<span class="ruby-value">:paranoid</span> =<span class="ruby-operator">></span> <span class="ruby-value">:very</span>
|
|
678
|
+
}).<span class="ruby-identifier">import</span>(<span class="ruby-identifier">options</span>)
|
|
679
|
+
|
|
680
|
+
<span class="ruby-identifier">ssh_options</span>[<span class="ruby-value">:port</span>] = <span class="ruby-identifier">port</span>
|
|
681
|
+
<span class="ruby-identifier">ssh_options</span>[<span class="ruby-value">:keys</span>] = <span class="ruby-identifier">private_key</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">?</span> [] <span class="ruby-operator">:</span> [ <span class="ruby-identifier">private_key</span> ]
|
|
682
|
+
|
|
683
|
+
<span class="ruby-identifier">session_id</span> = <span class="ruby-identifier">session_id</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>)
|
|
684
|
+
|
|
685
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">reset</span> <span class="ruby-operator">||</span> <span class="ruby-operator">!</span> <span class="ruby-identifier">@@sessions</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">session_id</span>)
|
|
686
|
+
<span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">session_id</span>] = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SSH</span>.<span class="ruby-identifier">start</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">ssh_options</span>.<span class="ruby-identifier">export</span>)
|
|
687
|
+
<span class="ruby-keyword">end</span>
|
|
688
|
+
<span class="ruby-keyword">yield</span>(<span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">session_id</span>]) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">session_id</span>]
|
|
689
|
+
<span class="ruby-identifier">@@sessions</span>[<span class="ruby-identifier">session_id</span>]
|
|
690
|
+
<span class="ruby-keyword">end</span></pre>
|
|
691
|
+
</div><!-- session-source -->
|
|
692
|
+
|
|
693
|
+
</div>
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
</div><!-- session-method -->
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
<div id="method-c-session_id" class="method-detail ">
|
|
702
|
+
|
|
703
|
+
<div class="method-heading">
|
|
704
|
+
<span class="method-name">session_id</span><span
|
|
705
|
+
class="method-args">(hostname, user)</span>
|
|
706
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
707
|
+
</div>
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
<div class="method-description">
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
<div class="method-source-code" id="session_id-source">
|
|
717
|
+
<pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 108</span>
|
|
718
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">session_id</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>)
|
|
719
|
+
<span class="ruby-node">"#{hostname}-#{user}"</span>
|
|
720
|
+
<span class="ruby-keyword">end</span></pre>
|
|
721
|
+
</div><!-- session_id-source -->
|
|
722
|
+
|
|
723
|
+
</div>
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
</div><!-- session_id-method -->
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
<div id="method-c-terminal" class="method-detail ">
|
|
732
|
+
|
|
733
|
+
<div class="method-heading">
|
|
734
|
+
<span class="method-name">terminal</span><span
|
|
735
|
+
class="method-args">(hostname, user, options = {})</span>
|
|
736
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
737
|
+
</div>
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
<div class="method-description">
|
|
741
|
+
|
|
742
|
+
<p>Inspired by vagrant ssh implementation</p>
|
|
743
|
+
|
|
744
|
+
<p>See: <a
|
|
745
|
+
href="https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/util/ssh.rb">github.com/mitchellh/vagrant/blob/master/lib/vagrant/util/ssh.rb</a></p>
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
<div class="method-source-code" id="terminal-source">
|
|
750
|
+
<pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 307</span>
|
|
751
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">terminal</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">options</span> = {})
|
|
752
|
+
<span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>)
|
|
753
|
+
<span class="ruby-identifier">ssh_path</span> = <span class="ruby-identifier">nucleon_locate</span>(<span class="ruby-string">"ssh"</span>)
|
|
754
|
+
|
|
755
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">SSHUnavailable</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">ssh_path</span>
|
|
756
|
+
|
|
757
|
+
<span class="ruby-identifier">port</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:port</span>, <span class="ruby-value">22</span>)
|
|
758
|
+
<span class="ruby-identifier">private_keys</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:private_keys</span>, <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">'HOME'</span>], <span class="ruby-string">'.ssh'</span>, <span class="ruby-string">'id_rsa'</span>))
|
|
759
|
+
|
|
760
|
+
<span class="ruby-identifier">command_options</span> = [
|
|
761
|
+
<span class="ruby-node">"#{user}@#{hostname}"</span>,
|
|
762
|
+
<span class="ruby-string">"-p"</span>, <span class="ruby-identifier">port</span>.<span class="ruby-identifier">to_s</span>,
|
|
763
|
+
<span class="ruby-string">"-o"</span>, <span class="ruby-string">"Compression=yes"</span>,
|
|
764
|
+
<span class="ruby-string">"-o"</span>, <span class="ruby-string">"DSAAuthentication=yes"</span>,
|
|
765
|
+
<span class="ruby-string">"-o"</span>, <span class="ruby-string">"LogLevel=FATAL"</span>,
|
|
766
|
+
<span class="ruby-string">"-o"</span>, <span class="ruby-string">"StrictHostKeyChecking=no"</span>,
|
|
767
|
+
<span class="ruby-string">"-o"</span>, <span class="ruby-string">"UserKnownHostsFile=/dev/null"</span>,
|
|
768
|
+
<span class="ruby-string">"-o"</span>, <span class="ruby-string">"IdentitiesOnly=yes"</span>
|
|
769
|
+
]
|
|
770
|
+
|
|
771
|
+
<span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">array</span>(<span class="ruby-identifier">private_keys</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
|
|
772
|
+
<span class="ruby-identifier">command_options</span> <span class="ruby-operator">+=</span> [ <span class="ruby-string">"-i"</span>, <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">path</span>) ]
|
|
773
|
+
<span class="ruby-keyword">end</span>
|
|
774
|
+
|
|
775
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:forward_x11</span>, <span class="ruby-keyword">false</span>)
|
|
776
|
+
<span class="ruby-identifier">command_options</span> <span class="ruby-operator">+=</span> [
|
|
777
|
+
<span class="ruby-string">"-o"</span>, <span class="ruby-string">"ForwardX11=yes"</span>,
|
|
778
|
+
<span class="ruby-string">"-o"</span>, <span class="ruby-string">"ForwardX11Trusted=yes"</span>
|
|
779
|
+
]
|
|
780
|
+
<span class="ruby-keyword">end</span>
|
|
781
|
+
|
|
782
|
+
<span class="ruby-identifier">command_options</span> <span class="ruby-operator">+=</span> [ <span class="ruby-string">"-o"</span>, <span class="ruby-node">"ProxyCommand=#{config[:proxy_command]}"</span> ] <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:proxy_command</span>, <span class="ruby-keyword">false</span>)
|
|
783
|
+
<span class="ruby-identifier">command_options</span> <span class="ruby-operator">+=</span> [ <span class="ruby-string">"-o"</span>, <span class="ruby-string">"ForwardAgent=yes"</span> ] <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:forward_agent</span>, <span class="ruby-keyword">false</span>)
|
|
784
|
+
|
|
785
|
+
<span class="ruby-identifier">command_options</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">array</span>(<span class="ruby-identifier">config</span>[<span class="ruby-value">:extra_args</span>])) <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:extra_args</span>, <span class="ruby-keyword">false</span>)
|
|
786
|
+
|
|
787
|
+
<span class="ruby-comment">#---</span>
|
|
788
|
+
|
|
789
|
+
<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">info</span>(<span class="ruby-node">"Executing SSH in subprocess: #{command_options.inspect}"</span>)
|
|
790
|
+
|
|
791
|
+
<span class="ruby-identifier">process</span> = <span class="ruby-constant">ChildProcess</span>.<span class="ruby-identifier">build</span>(<span class="ruby-string">'ssh'</span>, *<span class="ruby-identifier">command_options</span>)
|
|
792
|
+
<span class="ruby-identifier">process</span>.<span class="ruby-identifier">io</span>.<span class="ruby-identifier">inherit!</span>
|
|
793
|
+
|
|
794
|
+
<span class="ruby-identifier">process</span>.<span class="ruby-identifier">start</span>
|
|
795
|
+
<span class="ruby-identifier">process</span>.<span class="ruby-identifier">wait</span>
|
|
796
|
+
<span class="ruby-identifier">process</span>.<span class="ruby-identifier">exit_code</span>
|
|
797
|
+
<span class="ruby-keyword">end</span></pre>
|
|
798
|
+
</div><!-- terminal-source -->
|
|
799
|
+
|
|
800
|
+
</div>
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
</div><!-- terminal-method -->
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
<div id="method-c-upload" class="method-detail ">
|
|
809
|
+
|
|
810
|
+
<div class="method-heading">
|
|
811
|
+
<span class="method-name">upload</span><span
|
|
812
|
+
class="method-args">(hostname, user, local_path, remote_path, options = {}) { |name, sent, total| ... }</span>
|
|
813
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
814
|
+
</div>
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
<div class="method-description">
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
<div class="method-source-code" id="upload-source">
|
|
824
|
+
<pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 265</span>
|
|
825
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">upload</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">options</span> = {})
|
|
826
|
+
<span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>)
|
|
827
|
+
|
|
828
|
+
<span class="ruby-identifier">require</span> <span class="ruby-string">'net/scp'</span>
|
|
829
|
+
|
|
830
|
+
<span class="ruby-comment"># Accepted options:</span>
|
|
831
|
+
<span class="ruby-comment"># * :recursive - the +local+ parameter refers to a local directory, which</span>
|
|
832
|
+
<span class="ruby-comment"># should be uploaded to a new directory named +remote+ on the remote</span>
|
|
833
|
+
<span class="ruby-comment"># server.</span>
|
|
834
|
+
<span class="ruby-comment"># * :preserve - the atime and mtime of the file should be preserved.</span>
|
|
835
|
+
<span class="ruby-comment"># * :verbose - the process should result in verbose output on the server</span>
|
|
836
|
+
<span class="ruby-comment"># end (useful for debugging).</span>
|
|
837
|
+
<span class="ruby-comment"># * :chunk_size - the size of each "chunk" that should be sent. Defaults</span>
|
|
838
|
+
<span class="ruby-comment"># to 2048. Changing this value may improve throughput at the expense</span>
|
|
839
|
+
<span class="ruby-comment"># of decreasing interactivity.</span>
|
|
840
|
+
<span class="ruby-comment">#</span>
|
|
841
|
+
<span class="ruby-identifier">config</span>.<span class="ruby-identifier">init</span>(<span class="ruby-value">:recursive</span>, <span class="ruby-keyword">true</span>)
|
|
842
|
+
<span class="ruby-identifier">config</span>.<span class="ruby-identifier">init</span>(<span class="ruby-value">:preserve</span>, <span class="ruby-keyword">true</span>)
|
|
843
|
+
<span class="ruby-identifier">config</span>.<span class="ruby-identifier">init</span>(<span class="ruby-value">:verbose</span>, <span class="ruby-keyword">true</span>)
|
|
844
|
+
<span class="ruby-identifier">config</span>.<span class="ruby-identifier">init</span>(<span class="ruby-value">:chunk_size</span>, <span class="ruby-value">2048</span>)
|
|
845
|
+
|
|
846
|
+
<span class="ruby-identifier">blocking</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:blocking</span>, <span class="ruby-keyword">true</span>)
|
|
847
|
+
|
|
848
|
+
<span class="ruby-identifier">session</span>(<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">user</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ssh</span><span class="ruby-operator">|</span>
|
|
849
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">blocking</span>
|
|
850
|
+
<span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">upload!</span>(<span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">export</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">sent</span>, <span class="ruby-identifier">total</span><span class="ruby-operator">|</span>
|
|
851
|
+
<span class="ruby-keyword">yield</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">sent</span>, <span class="ruby-identifier">total</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
|
852
|
+
<span class="ruby-keyword">end</span>
|
|
853
|
+
<span class="ruby-keyword">else</span>
|
|
854
|
+
<span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">upload</span>(<span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">remote_path</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">export</span>)
|
|
855
|
+
<span class="ruby-keyword">end</span>
|
|
856
|
+
<span class="ruby-keyword">end</span>
|
|
857
|
+
<span class="ruby-keyword">end</span></pre>
|
|
858
|
+
</div><!-- upload-source -->
|
|
859
|
+
|
|
860
|
+
</div>
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
</div><!-- upload-method -->
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
<div id="method-c-valid-3F" class="method-detail ">
|
|
869
|
+
|
|
870
|
+
<div class="method-heading">
|
|
871
|
+
<span class="method-name">valid?</span><span
|
|
872
|
+
class="method-args">(public_ssh_key)</span>
|
|
873
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
874
|
+
</div>
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
<div class="method-description">
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
<div class="method-source-code" id="valid-3F-source">
|
|
884
|
+
<pre><span class="ruby-comment"># File lib/core/util/ssh.rb, line 64</span>
|
|
885
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">valid?</span>(<span class="ruby-identifier">public_ssh_key</span>)
|
|
886
|
+
<span class="ruby-constant">SSHKey</span>.<span class="ruby-identifier">valid_ssh_public_key?</span>(<span class="ruby-identifier">public_ssh_key</span>)
|
|
887
|
+
<span class="ruby-keyword">end</span></pre>
|
|
888
|
+
</div><!-- valid-3F-source -->
|
|
889
|
+
|
|
890
|
+
</div>
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
</div><!-- valid-3F-method -->
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
</section><!-- public-class-method-details -->
|
|
899
|
+
|
|
900
|
+
</section><!-- 5Buntitled-5D -->
|
|
901
|
+
|
|
902
|
+
</div><!-- documentation -->
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
<footer id="validator-badges">
|
|
906
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
907
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.2.
|
|
908
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
909
|
+
</footer>
|
|
910
|
+
|