convox_installer 1.0.7 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +23 -1
- data/.vscode/settings.json +2 -2
- data/Gemfile +2 -2
- data/README.md +8 -5
- data/convox_installer.gemspec +18 -17
- data/examples/full_installation.rb +75 -75
- data/lib/convox/client.rb +133 -94
- data/lib/convox.rb +1 -1
- data/lib/convox_installer/config.rb +38 -33
- data/lib/convox_installer/requirements.rb +27 -18
- data/lib/convox_installer/version.rb +1 -1
- data/lib/convox_installer.rb +7 -7
- data/spec/lib/convox/client_spec.rb +92 -56
- data/spec/lib/convox_installer/config_spec.rb +141 -141
- data/spec/lib/convox_installer/requirements_spec.rb +63 -34
- data/spec/spec_helper.rb +1 -1
- metadata +21 -20
@@ -1,8 +1,8 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
-
require
|
4
|
-
require
|
5
|
-
require
|
3
|
+
require 'highline'
|
4
|
+
require 'os'
|
5
|
+
require 'logger'
|
6
6
|
|
7
7
|
module ConvoxInstaller
|
8
8
|
class Requirements
|
@@ -10,46 +10,55 @@ module ConvoxInstaller
|
|
10
10
|
|
11
11
|
def initialize(options = {})
|
12
12
|
@ecr_label = options[:ecr_label]
|
13
|
-
@logger = Logger.new(
|
13
|
+
@logger = Logger.new($stdout)
|
14
14
|
logger.level = options[:log_level] || Logger::INFO
|
15
15
|
end
|
16
16
|
|
17
17
|
def ensure_requirements!
|
18
|
-
logger.debug
|
18
|
+
logger.debug 'Checking for required commands...'
|
19
19
|
|
20
20
|
@missing_packages = []
|
21
|
-
unless
|
21
|
+
unless command_present? 'convox'
|
22
22
|
@missing_packages << {
|
23
|
-
name:
|
24
|
-
brew:
|
25
|
-
docs:
|
23
|
+
name: 'convox',
|
24
|
+
brew: 'convox',
|
25
|
+
docs: 'https://docs.convox.com/introduction/installation'
|
26
26
|
}
|
27
27
|
end
|
28
28
|
|
29
|
-
unless
|
29
|
+
unless command_present? 'aws'
|
30
30
|
@missing_packages << {
|
31
|
-
name:
|
32
|
-
brew:
|
33
|
-
docs:
|
31
|
+
name: 'aws',
|
32
|
+
brew: 'awscli',
|
33
|
+
docs: 'https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html'
|
34
34
|
}
|
35
35
|
end
|
36
36
|
|
37
37
|
if @missing_packages.any?
|
38
|
-
logger.error
|
38
|
+
logger.error 'This script requires the convox and AWS CLI tools.'
|
39
39
|
if OS.mac?
|
40
|
-
logger.error
|
41
|
-
"#{@missing_packages.map { |p| p[:brew] }.join(
|
40
|
+
logger.error 'Please run: brew install ' \
|
41
|
+
"#{@missing_packages.map { |p| p[:brew] }.join(' ')}"
|
42
42
|
else
|
43
|
-
logger.error
|
43
|
+
logger.error 'Installation Instructions:'
|
44
44
|
@missing_packages.each do |package|
|
45
45
|
logger.error "* #{package[:name]}: #{package[:docs]}"
|
46
46
|
end
|
47
47
|
end
|
48
48
|
quit!
|
49
49
|
end
|
50
|
+
|
51
|
+
client = Convox::Client.new
|
52
|
+
return if client.convox_2_cli?
|
53
|
+
|
54
|
+
logger.error 'This script requires Convox CLI version 2.x.x. ' \
|
55
|
+
"Your Convox CLI version is: #{client.cli_version_string}"
|
56
|
+
logger.error 'Please follow the instructions here to downgrade your ' \
|
57
|
+
'Convox CLI version: https://docsv2.convox.com/introduction/installation'
|
58
|
+
quit!
|
50
59
|
end
|
51
60
|
|
52
|
-
def
|
61
|
+
def command_present?(command)
|
53
62
|
path = find_command command
|
54
63
|
if path.present?
|
55
64
|
logger.debug "=> Found #{command}: #{path}"
|
data/lib/convox_installer.rb
CHANGED
@@ -1,10 +1,10 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
-
require
|
4
|
-
require
|
5
|
-
require
|
6
|
-
require
|
7
|
-
require
|
3
|
+
require 'active_support'
|
4
|
+
require 'active_support/core_ext'
|
5
|
+
require 'convox_installer/config'
|
6
|
+
require 'convox_installer/requirements'
|
7
|
+
require 'convox'
|
8
8
|
|
9
9
|
module ConvoxInstaller
|
10
10
|
def client
|
@@ -12,7 +12,7 @@ module ConvoxInstaller
|
|
12
12
|
end
|
13
13
|
|
14
14
|
def config
|
15
|
-
options = {log_level: @log_level}
|
15
|
+
options = { log_level: @log_level }
|
16
16
|
options[:prompts] = @prompts if @prompts
|
17
17
|
@config ||= Config.new(options)
|
18
18
|
end
|
@@ -32,7 +32,7 @@ module ConvoxInstaller
|
|
32
32
|
%w[
|
33
33
|
backup_convox_host_and_rack
|
34
34
|
install_convox
|
35
|
-
|
35
|
+
validate_convox_auth_and_write_host!
|
36
36
|
validate_convox_rack!
|
37
37
|
convox_rack_data
|
38
38
|
create_convox_app!
|
@@ -1,20 +1,54 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
-
require
|
3
|
+
require 'convox/client'
|
4
4
|
|
5
5
|
RSpec.describe Convox::Client do
|
6
|
-
let(:home_dir) { File.expand_path(
|
6
|
+
let(:home_dir) { File.expand_path('~') }
|
7
7
|
|
8
|
-
it
|
8
|
+
it 'finds the authentication details in ~/.convox/auth' do
|
9
9
|
expect(File).to receive(:exist?).with("#{home_dir}/.convox/auth").and_return(true)
|
10
10
|
expect(File).to receive(:read).with("#{home_dir}/.convox/auth").and_return(
|
11
11
|
'{ "test.example.com": "1234567890" }'
|
12
12
|
)
|
13
13
|
client = described_class.new
|
14
|
-
expect(client.auth).to eq(
|
14
|
+
expect(client.auth).to eq('test.example.com' => '1234567890')
|
15
15
|
end
|
16
16
|
|
17
|
-
|
17
|
+
describe 'Convox CLI version' do
|
18
|
+
let(:client) { described_class.new }
|
19
|
+
|
20
|
+
it 'returns the convox CLI version output for 20210208170413' do
|
21
|
+
expect(client).to receive(:cli_version_string).at_least(:once).and_return('20210208170413')
|
22
|
+
expect(client.convox_2_cli?).to be true
|
23
|
+
expect(client.convox_3_cli?).to be false
|
24
|
+
end
|
25
|
+
|
26
|
+
it 'returns the convox CLI version output for 20200101130413' do
|
27
|
+
expect(client).to receive(:cli_version_string).at_least(:once).and_return('20200101130413')
|
28
|
+
expect(client.convox_2_cli?).to be true
|
29
|
+
expect(client.convox_3_cli?).to be false
|
30
|
+
end
|
31
|
+
|
32
|
+
it 'returns the convox CLI version output for 3.0.0' do
|
33
|
+
expect(client).to receive(:cli_version_string).at_least(:once).and_return('3.0.0')
|
34
|
+
expect(client.convox_2_cli?).to be false
|
35
|
+
expect(client.convox_3_cli?).to be true
|
36
|
+
end
|
37
|
+
|
38
|
+
it 'returns the convox CLI version output for 3.1.3' do
|
39
|
+
expect(client).to receive(:cli_version_string).at_least(:once).and_return('3.1.3')
|
40
|
+
expect(client.convox_2_cli?).to be false
|
41
|
+
expect(client.convox_3_cli?).to be true
|
42
|
+
end
|
43
|
+
|
44
|
+
it 'returns the convox CLI version output for 4.0.0' do
|
45
|
+
expect(client).to receive(:cli_version_string).at_least(:once).and_return('4.0.0')
|
46
|
+
expect(client.convox_2_cli?).to be false
|
47
|
+
expect(client.convox_3_cli?).to be false
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
it 'backups existing Convox host and rack files' do
|
18
52
|
expect(File).to receive(:exist?).with(
|
19
53
|
"#{home_dir}/.convox/host"
|
20
54
|
).and_return(true)
|
@@ -34,61 +68,63 @@ RSpec.describe Convox::Client do
|
|
34
68
|
client.backup_convox_host_and_rack
|
35
69
|
end
|
36
70
|
|
37
|
-
describe
|
38
|
-
it
|
71
|
+
describe '#install' do
|
72
|
+
it 'requires the correct config vars' do
|
39
73
|
client = described_class.new
|
40
|
-
expect { client.install_convox }.to raise_error(
|
74
|
+
expect { client.install_convox }.to raise_error('aws_region is missing from the config!')
|
41
75
|
|
42
|
-
client = described_class.new(config: {aws_region:
|
43
|
-
expect { client.install_convox }.to raise_error(
|
76
|
+
client = described_class.new(config: { aws_region: 'us-east-1' })
|
77
|
+
expect { client.install_convox }.to raise_error('stack_name is missing from the config!')
|
44
78
|
end
|
45
79
|
|
46
|
-
it
|
80
|
+
it 'runs the correct convox CLI command' do
|
47
81
|
client = described_class.new(
|
48
82
|
config: {
|
49
|
-
aws_region:
|
50
|
-
aws_access_key_id:
|
51
|
-
aws_secret_access_key:
|
52
|
-
stack_name:
|
53
|
-
instance_type:
|
54
|
-
}
|
83
|
+
aws_region: 'us-east-1',
|
84
|
+
aws_access_key_id: 'asdf',
|
85
|
+
aws_secret_access_key: '1234',
|
86
|
+
stack_name: 'asdf',
|
87
|
+
instance_type: 't3.medium'
|
88
|
+
}
|
55
89
|
)
|
56
90
|
|
57
91
|
expect(client.logger).to receive(:info)
|
58
92
|
expect(client).to receive(:run_convox_command!).with(
|
59
|
-
|
60
|
-
"
|
61
|
-
|
62
|
-
|
63
|
-
|
93
|
+
'rack install aws --name "asdf" "InstanceType=t3.medium" ' \
|
94
|
+
'"BuildInstance="',
|
95
|
+
'AWS_ACCESS_KEY_ID' => 'asdf',
|
96
|
+
'AWS_REGION' => 'us-east-1',
|
97
|
+
'AWS_SECRET_ACCESS_KEY' => '1234'
|
64
98
|
)
|
65
99
|
client.install_convox
|
66
100
|
end
|
67
101
|
end
|
68
102
|
|
69
|
-
describe
|
70
|
-
it
|
103
|
+
describe '#validate_convox_auth_and_write_host!' do
|
104
|
+
it 'requires the correct config vars' do
|
71
105
|
client = described_class.new
|
72
|
-
expect
|
106
|
+
expect do
|
107
|
+
client.validate_convox_auth_and_write_host!
|
108
|
+
end.to raise_error('aws_region is missing from the config!')
|
73
109
|
end
|
74
110
|
|
75
|
-
it
|
111
|
+
it 'raises an error if auth file is missing' do
|
76
112
|
client = described_class.new(
|
77
113
|
config: {
|
78
|
-
aws_region:
|
79
|
-
stack_name:
|
80
|
-
}
|
114
|
+
aws_region: 'us-east-1',
|
115
|
+
stack_name: 'asdf'
|
116
|
+
}
|
81
117
|
)
|
82
118
|
expect(File).to receive(:exist?).with(
|
83
119
|
"#{home_dir}/.convox/auth"
|
84
120
|
).and_return(false)
|
85
121
|
|
86
|
-
expect
|
87
|
-
client.
|
88
|
-
|
122
|
+
expect do
|
123
|
+
client.validate_convox_auth_and_write_host!
|
124
|
+
end.to raise_error(/Could not find auth file at /)
|
89
125
|
end
|
90
126
|
|
91
|
-
it
|
127
|
+
it 'sets ~/.convox/host if a matching host is found in the auth file' do
|
92
128
|
expect(File).to receive(:exist?).with(
|
93
129
|
"#{home_dir}/.convox/auth"
|
94
130
|
).twice.and_return(true)
|
@@ -98,19 +134,19 @@ RSpec.describe Convox::Client do
|
|
98
134
|
)
|
99
135
|
client = described_class.new(
|
100
136
|
config: {
|
101
|
-
aws_region:
|
102
|
-
stack_name:
|
103
|
-
}
|
137
|
+
aws_region: 'us-west-2',
|
138
|
+
stack_name: 'convox-test'
|
139
|
+
}
|
104
140
|
)
|
105
|
-
expect(client).to receive(:
|
106
|
-
|
141
|
+
expect(client).to receive(:write_host).with(
|
142
|
+
'convox-test-697645520.us-west-2.elb.amazonaws.com'
|
107
143
|
)
|
108
|
-
expect(client.
|
109
|
-
eq(
|
144
|
+
expect(client.validate_convox_auth_and_write_host!).to(
|
145
|
+
eq('convox-test-697645520.us-west-2.elb.amazonaws.com')
|
110
146
|
)
|
111
147
|
end
|
112
148
|
|
113
|
-
it
|
149
|
+
it 'raises an error if no matching host is found' do
|
114
150
|
expect(File).to receive(:exist?).with(
|
115
151
|
"#{home_dir}/.convox/auth"
|
116
152
|
).twice.and_return(true)
|
@@ -120,17 +156,17 @@ RSpec.describe Convox::Client do
|
|
120
156
|
)
|
121
157
|
client = described_class.new(
|
122
158
|
config: {
|
123
|
-
aws_region:
|
124
|
-
stack_name:
|
125
|
-
}
|
159
|
+
aws_region: 'us-east-1',
|
160
|
+
stack_name: 'convox-test'
|
161
|
+
}
|
126
162
|
)
|
127
|
-
expect
|
128
|
-
client.
|
129
|
-
|
130
|
-
|
163
|
+
expect do
|
164
|
+
client.validate_convox_auth_and_write_host!
|
165
|
+
end.to raise_error('Could not find matching authentication for ' \
|
166
|
+
'region: us-east-1, stack: convox-test')
|
131
167
|
end
|
132
168
|
|
133
|
-
it
|
169
|
+
it 'raises an error if it finds multiple matching hosts' do
|
134
170
|
expect(File).to receive(:exist?).with(
|
135
171
|
"#{home_dir}/.convox/auth"
|
136
172
|
).twice.and_return(true)
|
@@ -141,14 +177,14 @@ RSpec.describe Convox::Client do
|
|
141
177
|
)
|
142
178
|
client = described_class.new(
|
143
179
|
config: {
|
144
|
-
aws_region:
|
145
|
-
stack_name:
|
146
|
-
}
|
180
|
+
aws_region: 'us-west-2',
|
181
|
+
stack_name: 'convox-test'
|
182
|
+
}
|
147
183
|
)
|
148
|
-
expect
|
149
|
-
client.
|
150
|
-
|
151
|
-
|
184
|
+
expect do
|
185
|
+
client.validate_convox_auth_and_write_host!
|
186
|
+
end.to raise_error('Found multiple matching hosts for ' \
|
187
|
+
'region: us-west-2, stack: convox-test')
|
152
188
|
end
|
153
189
|
end
|
154
190
|
end
|