1
=== modified file 'quickstart/cli/ui.py'
2
--- quickstart/cli/ui.py	2013-12-18 11:34:12 +0000
3
+++ quickstart/cli/ui.py	2013-12-20 10:30:54 +0000
4
@@ -31,6 +31,9 @@
5
31
    # See <http://excess.org/urwid/docs/reference/constants.html
31
    # See <http://excess.org/urwid/docs/reference/constants.html
6
32
    # foreground-and-background-colors>.
32
    # foreground-and-background-colors>.
7
33
    (None, 'light gray', 'black'),
33
    (None, 'light gray', 'black'),
8
34
    ('dialog', 'dark gray', 'light gray'),
9
35
    ('dialog header', 'light gray,bold', 'dark blue'),
10
36
    ('control alert', 'light red', 'light gray'),
11
34
    ('controls', 'dark gray', 'light gray'),
37
    ('controls', 'dark gray', 'light gray'),
12
35
    ('edit', 'white,underline', 'black'),
38
    ('edit', 'white,underline', 'black'),
13
36
    ('error', 'light red', 'black'),
39
    ('error', 'light red', 'black'),
14
@@ -47,6 +50,7 @@
15
47
# Map attributes to new attributes to apply when the widget is selected.
50
# Map attributes to new attributes to apply when the widget is selected.
16
48
FOCUS_MAP = {
51
FOCUS_MAP = {
17
49
    None: 'selected',
52
    None: 'selected',
18
53
    'control alert': 'error selected',
19
50
    'error': 'error selected',
54
    'error': 'error selected',
20
51
}
55
}
21
52
# Define a default padding for the Urwid application.
56
# Define a default padding for the Urwid application.
22
@@ -100,6 +104,69 @@
23
100
        self._w = urwid.AttrMap(icon, None, FOCUS_MAP)
104
        self._w = urwid.AttrMap(icon, None, FOCUS_MAP)
24
101
105
25
102
106
26
107
def show_dialog(
27
108
        app, title, message, actions=None, dismissable=True,
28
109
        width=None, height=None):
29
110
    """Display an interactive modal dialog.
30
111
31
112
    This function receives the following arguments:
32
113
        - app: the App named tuple used to configure the current interactive
33
114
          session (see the quickstart.cli.base module);
34
115
        - title: the title of the message dialog;
35
116
        - message: the help message displayed in the dialog;
36
117
        - actions: the actions which can be executed from the dialog, as a
37
118
          sequence of (caption, callback) tuples. Those pairs are used to
38
119
          generate the clickable controls (MenuButton instances) displayed
39
120
          in the dialog;
40
121
        - dismissable: if set to True, a "cancel" button is prepended to the
41
122
          list of controls. Clicking the "cancel" button, the dialog just
42
123
          disappears without further changes to the state of the application;
43
124
        - width and height: optional dialog width and height as defined in
44
125
          Urwid, e.g. 'pack', 'relative' or the number of rows/columns.
45
126
          If not provided, the function tries to generate suitable defaults.
46
127
47
128
    Return a function that can be called to dismiss the dialog.
48
129
    """
49
130
    original_contents = app.get_contents()
50
131
    # Set up the dialog's header.
51
132
    header = urwid.Pile([
52
133
        urwid.Divider(),
53
134
        urwid.Text(title, align='center'),
54
135
        urwid.Divider(),
55
136
    ])
56
137
    # Set up the controls displayed in the dialog.
57
138
    if actions is None:
58
139
        controls = []
59
140
    else:
60
141
        controls = [
61
142
            MenuButton(caption, callback) for caption, callback in actions]
62
143
    # The dialog is removed by restoring the view original contents.
63
144
    dismiss = thunk(app.set_contents, original_contents)
64
145
    if dismissable:
65
146
        controls.insert(0, MenuButton('cancel', dismiss))
66
147
    # Create the listbox that replaces the original view contents.
67
148
    widgets = [
68
149
        urwid.AttrMap(header, 'dialog header'),
69
150
        urwid.Divider(),
70
151
        urwid.Text(message, align='center'),
71
152
        create_controls(*controls),
72
153
    ]
73
154
    listbox = urwid.ListBox(urwid.SimpleFocusListWalker(widgets))
74
155
    if width is None:
75
156
        # Calculate the dialog width: the max from the title/message length +
76
157
        # two padding spaces for each side.
77
158
        width = max(len(title), len(message)) + 4
78
159
    if height is None:
79
160
        # A height of eleven is usually enough for the dialog.
80
161
        height = 11
81
162
    contents = urwid.Overlay(
82
163
        urwid.AttrMap(listbox, 'dialog'), original_contents,
83
164
        align='center', width=width,
84
165
        valign='middle', height=height)
85
166
    app.set_contents(contents)
86
167
    return dismiss
87
168
88
169
89
103
def thunk(function, *args, **kwargs):
170
def thunk(function, *args, **kwargs):
90
104
    """Create and return a callable binding the given method and args/kwargs.
171
    """Create and return a callable binding the given method and args/kwargs.
91
105
172
92
106
173
93
=== modified file 'quickstart/cli/views.py'
94
--- quickstart/cli/views.py	2013-12-19 11:10:46 +0000
95
+++ quickstart/cli/views.py	2013-12-20 10:30:54 +0000
96
@@ -228,6 +228,23 @@
97
228
        app.set_message('{} successfully set as default'.format(env_name))
228
        app.set_message('{} successfully set as default'.format(env_name))
98
229
        index_view()
229
        index_view()
99
230
230
100
231
    def remove(env_data):
101
232
        # The environment deletion is confirmed: remove the environment from
102
233
        # the database, save the new env_db and return to the index view.
103
234
        envs.remove_env(env_db, env_data['name'])
104
235
        save_callable(env_db)
105
236
        index_view()
106
237
107
238
    def confirm_removal(env_data):
108
239
        # Ask confirmation before removing an environment.
109
240
        ui.show_dialog(
110
241
            app, 'Remove the {} environment'.format(env_data['name']),
111
242
            'This action cannot be undone!',
112
243
            actions=[
113
244
                (('control alert', 'confirm'), ui.thunk(remove, env_data)),
114
245
            ],
115
246
        )
116
247
117
231
    env_metadata = envs.get_env_metadata(env_type_db, env_data)
248
    env_metadata = envs.get_env_metadata(env_type_db, env_data)
118
232
    app.set_title(envs.get_env_short_description(env_data))
249
    app.set_title(envs.get_env_short_description(env_data))
119
233
    app.set_status('')
250
    app.set_status('')
120
@@ -254,8 +271,11 @@
121
254
    if not env_data['is-default']:
271
    if not env_data['is-default']:
122
255
        controls.append(
272
        controls.append(
123
256
            ui.MenuButton('set default', ui.thunk(set_default, env_data)))
273
            ui.MenuButton('set default', ui.thunk(set_default, env_data)))
126
257
    # XXX frankban 2013-12-18: implement the "remove env" functionality.
274
    controls.extend([
127
258
    # XXX frankban 2013-12-18: implement the env modification view.
275
        # XXX frankban 2013-12-18: implement the env modification view.
128
276
        ui.MenuButton(
129
277
            ('control alert', 'remove'), ui.thunk(confirm_removal, env_data)),
130
278
    ])
131
259
    widgets.append(ui.create_controls(*controls))
279
    widgets.append(ui.create_controls(*controls))
132
260
    listbox = urwid.ListBox(urwid.SimpleFocusListWalker(widgets))
280
    listbox = urwid.ListBox(urwid.SimpleFocusListWalker(widgets))
133
261
    app.set_contents(listbox)
281
    app.set_contents(listbox)
134
262
282
135
=== modified file 'quickstart/models/envs.py'
136
--- quickstart/models/envs.py	2013-12-17 15:30:48 +0000
137
+++ quickstart/models/envs.py	2013-12-20 10:30:54 +0000
138
@@ -296,6 +296,21 @@
139
296
        del env_db['default']
296
        del env_db['default']
140
297
297
141
298
298
142
299
def remove_env(env_db, env_name):
143
300
    """Remove the environment named env_name from the environments database.
144
301
145
302
    Raise a ValueError if the environment is not present in env_db.
146
303
    Without errors, the env_db is modified in place and None is returned.
147
304
    """
148
305
    try:
149
306
        del env_db['environments'][env_name]
150
307
    except KeyError:
151
308
        raise ValueError(
152
309
            b'the environment named {!r} does not exist'.format(env_name))
153
310
    if env_db.get('default') == env_name:
154
311
        del env_db['default']
155
312
156
313
157
299
def get_env_type_db():
314
def get_env_type_db():
158
300
    """Return the environments meta information based on provider types.
315
    """Return the environments meta information based on provider types.
159
301
316
160
302
317
161
=== modified file 'quickstart/tests/cli/helpers.py'
162
--- quickstart/tests/cli/helpers.py	2013-12-19 17:41:40 +0000
163
+++ quickstart/tests/cli/helpers.py	2013-12-20 10:30:54 +0000
164
@@ -18,6 +18,8 @@
165
18
18
166
19
from __future__ import unicode_literals
19
from __future__ import unicode_literals
167
20
20
168
21
import urwid
169
22
170
21
from quickstart.cli import ui
23
from quickstart.cli import ui
171
22
24
172
23
25
173
@@ -29,3 +31,36 @@
174
29
        with self.assertRaises(ui.AppExit) as context_manager:
31
        with self.assertRaises(ui.AppExit) as context_manager:
175
30
            loop.unhandled_input(ui.EXIT_KEY)
32
            loop.unhandled_input(ui.EXIT_KEY)
176
31
        return context_manager.exception.return_value
33
        return context_manager.exception.return_value
177
34
178
35
179
36
def get_button_caption(button):
180
37
    """Return the button caption as a string."""
181
38
    return button._w.original_widget.text
182
39
183
40
184
41
def emit(widget):
185
42
    """Emit the first signal associated withe the given widget.
186
43
187
44
    This is usually invoked to click buttons.
188
45
    """
189
46
    # Retrieve the first signal name (usually is 'click').
190
47
    signal_name = widget.signals[0]
191
48
    urwid.emit_signal(widget, signal_name, widget)
192
49
193
50
194
51
def inspect_dialog(contents):
195
52
    """Inspect the widgets composing the dialog.
196
53
197
54
    Return a tuple (title_widget, messaqe_widget, buttons) where:
198
55
        - title_widget is the Text widget displaying the dialog title;
199
56
        - message_widget is the Text widget displaying the dialog message;
200
57
        - buttons is a list of MenuButton widgets included in the dialog.
201
58
    """
202
59
    listbox = contents.top_w.base_widget
203
60
    header, _, message_widget, controls = listbox.body
204
61
    # The title widget is the second one in the header Pile.
205
62
    title_widget = header.base_widget.contents[1][0]
206
63
    # The button columns is the second widget in the Pile.
207
64
    columns = controls.contents[1][0].base_widget
208
65
    buttons = [content[0].base_widget for content in columns.contents]
209
66
    return title_widget, message_widget, buttons
210
32
67
211
=== modified file 'quickstart/tests/cli/test_ui.py'
212
--- quickstart/tests/cli/test_ui.py	2013-12-18 14:04:14 +0000
213
+++ quickstart/tests/cli/test_ui.py	2013-12-20 10:30:54 +0000
214
@@ -27,6 +27,7 @@
215
27
    base,
27
    base,
216
28
    ui,
28
    ui,
217
29
)
29
)
218
30
from quickstart.tests.cli import helpers as cli_helpers
219
30
31
220
31
32
221
32
class TestAppExit(unittest.TestCase):
33
class TestAppExit(unittest.TestCase):
222
@@ -95,6 +96,75 @@
223
95
        callback.assert_called_once_with(button)
96
        callback.assert_called_once_with(button)
224
96
97
225
97
98
226
99
class TestShowDialog(cli_helpers.CliAppTestsMixin, unittest.TestCase):
227
100
228
101
    def setUp(self):
229
102
        # Set up the base Urwid application.
230
103
        _, self.app = base.setup_urwid_app()
231
104
        self.original_contents = self.app.get_contents()
232
105
233
106
    def test_dialog_rendering(self):
234
107
        # The dialog is correctly displayed without additional controls.
235
108
        ui.show_dialog(self.app, 'my title', 'my message')
236
109
        contents = self.app.get_contents()
237
110
        self.assertIsNot(contents, self.original_contents)
238
111
        title_widget, message_widget, buttons = cli_helpers.inspect_dialog(
239
112
            contents)
240
113
        self.assertEqual('my title', title_widget.text)
241
114
        self.assertEqual('my message', message_widget.text)
242
115
        # The dialog only includes the "cancel" button.
243
116
        self.assertEqual(1, len(buttons))
244
117
        caption = cli_helpers.get_button_caption(buttons[0])
245
118
        self.assertEqual('cancel', caption)
246
119
247
120
    def test_dialog_cancel_action(self):
248
121
        # A dialog can be properly dismissed clicking the cancel button.
249
122
        ui.show_dialog(self.app, 'my title', 'my message')
250
123
        contents = self.app.get_contents()
251
124
        buttons = cli_helpers.inspect_dialog(contents)[2]
252
125
        cancel_button = buttons[0]
253
126
        cli_helpers.emit(cancel_button)
254
127
        # The original contents have been restored.
255
128
        self.assertIs(self.original_contents, self.app.get_contents())
256
129
257
130
    def test_dialog_customized_actions(self):
258
131
        # A button is displayed for each customized action provided.
259
132
        performed = []
260
133
        actions = [
261
134
            ('push me', ui.thunk(performed.append, 'push')),
262
135
            ('pull me', ui.thunk(performed.append, 'pull')),
263
136
        ]
264
137
        ui.show_dialog(self.app, 'my title', 'my message', actions=actions)
265
138
        contents = self.app.get_contents()
266
139
        buttons = cli_helpers.inspect_dialog(contents)[2]
267
140
        # Three buttons are displayed: "cancel", "push me" and "pull me".
268
141
        self.assertEqual(3, len(buttons))
269
142
        captions = [
270
143
            cli_helpers.get_button_caption(button) for button in buttons]
271
144
        self.assertEqual(['cancel', 'push me', 'pull me'], captions)
272
145
        push, pull = buttons[1:]
273
146
        # Click the "push me" button.
274
147
        cli_helpers.emit(push)
275
148
        self.assertEqual(['push'], performed)
276
149
        # Click the "pull me" button two times.
277
150
        cli_helpers.emit(pull)
278
151
        cli_helpers.emit(pull)
279
152
        self.assertEqual(['push', 'pull', 'pull'], performed)
280
153
281
154
    def test_not_dismissable(self):
282
155
        # The cancel button is not present if the dialog is not dismissable.
283
156
        actions = [('push me', lambda *args: None)]
284
157
        ui.show_dialog(
285
158
            self.app, 'my title', 'my message',
286
159
            actions=actions, dismissable=False)
287
160
        contents = self.app.get_contents()
288
161
        buttons = cli_helpers.inspect_dialog(contents)[2]
289
162
        # Only the "push me" button is displayed.
290
163
        self.assertEqual(1, len(buttons))
291
164
        caption = cli_helpers.get_button_caption(buttons[0])
292
165
        self.assertEqual('push me', caption)
293
166
294
167
295
98
class TestThunk(unittest.TestCase):
168
class TestThunk(unittest.TestCase):
296
99
169
297
100
    widget = 'test-widget'
170
    widget = 'test-widget'
298
101
171
299
=== modified file 'quickstart/tests/cli/test_views.py'
300
--- quickstart/tests/cli/test_views.py	2013-12-19 10:59:57 +0000
301
+++ quickstart/tests/cli/test_views.py	2013-12-20 10:30:54 +0000
302
@@ -119,19 +119,6 @@
303
119
        """
119
        """
304
120
        return lambda arg: isinstance(arg, cls)
120
        return lambda arg: isinstance(arg, cls)
305
121
121
306
122
    def get_button_caption(self, button):
307
123
        """Return the button caption as a string."""
308
124
        return button._w.original_widget.text
309
125
310
126
    def emit(self, widget):
311
127
        """Emit the first signal associated withe the given widget.
312
128
313
129
        This is usually invoked to click buttons.
314
130
        """
315
131
        # Retrieve the first signal name (usually is 'click').
316
132
        signal_name = widget.signals[0]
317
133
        urwid.emit_signal(widget, signal_name, widget)
318
134
319
135
122
320
136
class TestEnvIndex(EnvViewTestsMixin, unittest.TestCase):
123
class TestEnvIndex(EnvViewTestsMixin, unittest.TestCase):
321
137
124
322
@@ -177,10 +164,11 @@
323
177
            env_data = envs.get_env_data(env_db, env_name)
164
            env_data = envs.get_env_data(env_db, env_name)
324
178
            # The caption includes the environment description.
165
            # The caption includes the environment description.
325
179
            env_description = envs.get_env_short_description(env_data)
166
            env_description = envs.get_env_short_description(env_data)
327
180
            self.assertIn(env_description, self.get_button_caption(button))
167
            self.assertIn(
328
168
                env_description, cli_helpers.get_button_caption(button))
329
181
            # When the button is clicked, the detail view is called passing the
169
            # When the button is clicked, the detail view is called passing the
330
182
            # corresponding environment data.
170
            # corresponding environment data.
332
183
            self.emit(button)
171
            cli_helpers.emit(button)
333
184
            mock_env_detail.assert_called_once_with(
172
            mock_env_detail.assert_called_once_with(
334
185
                self.app, self.env_type_db, env_db, self.save_callable,
173
                self.app, self.env_type_db, env_db, self.save_callable,
335
186
                env_data)
174
                env_data)
336
@@ -197,7 +185,8 @@
337
197
        contents = self.app.get_contents()
185
        contents = self.app.get_contents()
338
198
        focused_widget = contents.get_focus()[0]
186
        focused_widget = contents.get_focus()[0]
339
199
        self.assertIsInstance(focused_widget, ui.MenuButton)
187
        self.assertIsInstance(focused_widget, ui.MenuButton)
341
200
        self.assertIn(env_description, self.get_button_caption(focused_widget))
188
        self.assertIn(
342
189
            env_description, cli_helpers.get_button_caption(focused_widget))
343
201
190
344
202
    def test_status_with_errors(self):
191
    def test_status_with_errors(self):
345
203
        # The status message explains how errors are displayed.
192
        # The status message explains how errors are displayed.
346
@@ -272,35 +261,36 @@
347
272
            self.assertEqual(expected_text, widget.text)
261
            self.assertEqual(expected_text, widget.text)
348
273
262
349
274
    def test_view_buttons(self):
263
    def test_view_buttons(self):
351
275
        # The following buttons are displayed: "back", "use" and "set default".
264
        # The following buttons are displayed: "back", "use", "set default" and
352
265
        # "remove".
353
276
        self.call_view(env_name='ec2-west')
266
        self.call_view(env_name='ec2-west')
354
277
        buttons = self.get_control_buttons()
267
        buttons = self.get_control_buttons()
357
278
        captions = [self.get_button_caption(button) for button in buttons]
268
        captions = map(cli_helpers.get_button_caption, buttons)
358
279
        self.assertEqual(['back', 'use', 'set default'], captions)
269
        self.assertEqual(['back', 'use', 'set default', 'remove'], captions)
359
280
270
360
281
    def test_view_buttons_default(self):
271
    def test_view_buttons_default(self):
361
282
        # If the environment is the default one, the "set default" button is
272
        # If the environment is the default one, the "set default" button is
363
283
        # not displayed. The buttons we expect are "back" and "use".
273
        # not displayed. The buttons we expect are "back", "use" and "remove".
364
284
        self.call_view(env_name='lxc')
274
        self.call_view(env_name='lxc')
365
285
        buttons = self.get_control_buttons()
275
        buttons = self.get_control_buttons()
368
286
        captions = [self.get_button_caption(button) for button in buttons]
276
        captions = map(cli_helpers.get_button_caption, buttons)
369
287
        self.assertEqual(['back', 'use'], captions)
277
        self.assertEqual(['back', 'use', 'remove'], captions)
370
288
278
371
289
    def test_view_buttons_error(self):
279
    def test_view_buttons_error(self):
372
290
        # If the environment is not valid, the "use" button is not displayed.
280
        # If the environment is not valid, the "use" button is not displayed.
374
291
        # The buttons we expect are "back" and "set default".
281
        # The buttons we expect are "back", "set default" and "remove".
375
292
        self.call_view(env_name='local-with-errors')
282
        self.call_view(env_name='local-with-errors')
376
293
        buttons = self.get_control_buttons()
283
        buttons = self.get_control_buttons()
379
294
        captions = [self.get_button_caption(button) for button in buttons]
284
        captions = map(cli_helpers.get_button_caption, buttons)
380
295
        self.assertEqual(['back', 'set default'], captions)
285
        self.assertEqual(['back', 'set default', 'remove'], captions)
381
296
286
382
297
    @mock.patch('quickstart.cli.views.env_index')
287
    @mock.patch('quickstart.cli.views.env_index')
383
298
    def test_back_button(self, mock_env_index):
288
    def test_back_button(self, mock_env_index):
384
299
        # The index view is called if the "back" button is clicked.
289
        # The index view is called if the "back" button is clicked.
385
300
        self.call_view(env_name='ec2-west')
290
        self.call_view(env_name='ec2-west')
387
301
        # The control buttons are: "back", "use" and "set default".
291
        # The "back" button is the first one.
388
302
        back_button = self.get_control_buttons()[0]
292
        back_button = self.get_control_buttons()[0]
390
303
        self.emit(back_button)
293
        cli_helpers.emit(back_button)
391
304
        mock_env_index.assert_called_once_with(
294
        mock_env_index.assert_called_once_with(
392
305
            self.app, self.env_type_db, self.env_db, self.save_callable)
295
            self.app, self.env_type_db, self.env_db, self.save_callable)
393
306
296
394
@@ -308,10 +298,10 @@
395
308
        # The application exits if the "use" button is clicked.
298
        # The application exits if the "use" button is clicked.
396
309
        # The env_db and the current environment data are returned.
299
        # The env_db and the current environment data are returned.
397
310
        self.call_view(env_name='ec2-west')
300
        self.call_view(env_name='ec2-west')
399
311
        # The control buttons are: "back", "use" and "set default".
301
        # The "use" button is the second one.
400
312
        use_button = self.get_control_buttons()[1]
302
        use_button = self.get_control_buttons()[1]
401
313
        with self.assertRaises(ui.AppExit) as context_manager:
303
        with self.assertRaises(ui.AppExit) as context_manager:
403
314
            self.emit(use_button)
304
            cli_helpers.emit(use_button)
404
315
        expected_return_value = (self.env_db, self.env_data)
305
        expected_return_value = (self.env_db, self.env_data)
405
316
        self.assertEqual(
306
        self.assertEqual(
406
317
            expected_return_value, context_manager.exception.return_value)
307
            expected_return_value, context_manager.exception.return_value)
407
@@ -321,9 +311,9 @@
408
321
        # The current environment is set as default if the "set default" button
311
        # The current environment is set as default if the "set default" button
409
322
        # is clicked. Subsequently the application switches to the index view.
312
        # is clicked. Subsequently the application switches to the index view.
410
323
        self.call_view(env_name='ec2-west')
313
        self.call_view(env_name='ec2-west')
412
324
        # The control buttons are: "back", "use" and "set default".
314
        # The "set default" button is the third one.
413
325
        set_default_button = self.get_control_buttons()[2]
315
        set_default_button = self.get_control_buttons()[2]
415
326
        self.emit(set_default_button)
316
        cli_helpers.emit(set_default_button)
416
327
        # The index view has been called passing the modified env_db as third
317
        # The index view has been called passing the modified env_db as third
417
328
        # argument.
318
        # argument.
418
329
        self.assertTrue(mock_env_index.called)
319
        self.assertTrue(mock_env_index.called)
419
@@ -333,6 +323,64 @@
420
333
        # The new env_db has been saved.
323
        # The new env_db has been saved.
421
334
        self.save_callable.assert_called_once_with(new_env_db)
324
        self.save_callable.assert_called_once_with(new_env_db)
422
335
325
423
326
    def test_remove_button(self):
424
327
        # A confirmation dialog is displayed if the "remove" button is clicked.
425
328
        self.call_view(env_name='ec2-west')
426
329
        original_contents = self.app.get_contents()
427
330
        # The "remove" button is the last one.
428
331
        remove_button = self.get_control_buttons()[-1]
429
332
        cli_helpers.emit(remove_button)
430
333
        # The original env detail contents have been replaced.
431
334
        contents = self.app.get_contents()
432
335
        self.assertIsNot(contents, original_contents)
433
336
        # A "remove" confirmation dialog is displayed.
434
337
        title_widget, message_widget, buttons = cli_helpers.inspect_dialog(
435
338
            contents)
436
339
        self.assertEqual('Remove the ec2-west environment', title_widget.text)
437
340
        self.assertEqual('This action cannot be undone!', message_widget.text)
438
341
        # The dialog includes the "cancel" and "confirm" buttons.
439
342
        self.assertEqual(2, len(buttons))
440
343
        captions = map(cli_helpers.get_button_caption, buttons)
441
344
        self.assertEqual(['cancel', 'confirm'], captions)
442
345
443
346
    def test_remove_cancelled(self):
444
347
        # The "remove" confirmation dialog can be safely dismissed.
445
348
        self.call_view(env_name='ec2-west')
446
349
        original_contents = self.app.get_contents()
447
350
        # The "remove" button is the last one.
448
351
        remove_button = self.get_control_buttons()[-1]
449
352
        cli_helpers.emit(remove_button)
450
353
        contents = self.app.get_contents()
451
354
        buttons = cli_helpers.inspect_dialog(contents)[2]
452
355
        # The "cancel" button is the first one in the dialog.
453
356
        cancel_button = buttons[0]
454
357
        cli_helpers.emit(cancel_button)
455
358
        # The original contents have been restored.
456
359
        self.assertIs(original_contents, self.app.get_contents())
457
360
458
361
    @mock.patch('quickstart.cli.views.env_index')
459
362
    def test_remove_confirmed(self, mock_env_index):
460
363
        # The current environment is removed if the "remove" button is clicked
461
364
        # and then the deletion is confirmed. Subsequently the application
462
365
        # switches to the index view.
463
366
        self.call_view(env_name='ec2-west')
464
367
        # The "remove" button is the last one.
465
368
        remove_button = self.get_control_buttons()[-1]
466
369
        cli_helpers.emit(remove_button)
467
370
        contents = self.app.get_contents()
468
371
        buttons = cli_helpers.inspect_dialog(contents)[2]
469
372
        # The "confirm" button is the second one in the dialog.
470
373
        confirm_button = buttons[1]
471
374
        cli_helpers.emit(confirm_button)
472
375
        # The index view has been called passing the modified env_db as third
473
376
        # argument.
474
377
        self.assertTrue(mock_env_index.called)
475
378
        new_env_db = mock_env_index.call_args[0][2]
476
379
        # The new env_db no longer includes the "ec2-west" environment.
477
380
        self.assertNotIn('ec2-west', new_env_db['environments'])
478
381
        # The new env_db has been saved.
479
382
        self.save_callable.assert_called_once_with(new_env_db)
480
383
481
336
    def test_status_with_errors(self):
384
    def test_status_with_errors(self):
482
337
        # The status message explains how field errors are displayed.
385
        # The status message explains how field errors are displayed.
483
338
        self.call_view(env_name='local-with-errors')
386
        self.call_view(env_name='local-with-errors')
484
339
387
485
=== modified file 'quickstart/tests/models/test_envs.py'
486
--- quickstart/tests/models/test_envs.py	2013-12-17 15:30:48 +0000
487
+++ quickstart/tests/models/test_envs.py	2013-12-20 10:30:54 +0000
488
@@ -225,7 +225,7 @@
489
225
        self.assertIn('new: contents', contents)
225
        self.assertIn('new: contents', contents)
490
226
226
491
227
227
493
228
class GetSetEnvDataTestsMixin(object):
228
class EnvDataTestsMixin(object):
494
229
    """Set up an initial environments dictionary."""
229
    """Set up an initial environments dictionary."""
495
230
230
496
231
    def setUp(self):
231
    def setUp(self):
497
@@ -245,7 +245,7 @@
498
245
            },
245
            },
499
246
        }
246
        }
500
247
        self.original = copy.deepcopy(self.env_db)
247
        self.original = copy.deepcopy(self.env_db)
502
248
        super(GetSetEnvDataTestsMixin, self).setUp()
248
        super(EnvDataTestsMixin, self).setUp()
503
249
249
504
250
    def assert_env_db_not_modified(self):
250
    def assert_env_db_not_modified(self):
505
251
        """Ensure the stored env_db is not modified."""
251
        """Ensure the stored env_db is not modified."""
506
@@ -253,8 +253,7 @@
507
253
253
508
254
254
509
255
class TestGetEnvData(
255
class TestGetEnvData(
512
256
        GetSetEnvDataTestsMixin, helpers.ValueErrorTestsMixin,
256
        EnvDataTestsMixin, helpers.ValueErrorTestsMixin, unittest.TestCase):
511
257
        unittest.TestCase):
513
258
257
514
259
    def test_env_not_found(self):
258
    def test_env_not_found(self):
515
260
        # A ValueError is raised if an environment with the given name is not
259
        # A ValueError is raised if an environment with the given name is not
516
@@ -301,8 +300,7 @@
517
301
300
518
302
301
519
303
class TestSetEnvData(
302
class TestSetEnvData(
522
304
        GetSetEnvDataTestsMixin, helpers.ValueErrorTestsMixin,
303
        EnvDataTestsMixin, helpers.ValueErrorTestsMixin, unittest.TestCase):
521
305
        unittest.TestCase):
523
306
304
524
307
    def test_error_no_name_key(self):
305
    def test_error_no_name_key(self):
525
308
        # A ValueError is raised if the env_data dictionary does not include
306
        # A ValueError is raised if the env_data dictionary does not include
526
@@ -469,6 +467,36 @@
527
469
        self.assertNotIn('default', self.env_db)
467
        self.assertNotIn('default', self.env_db)
528
470
468
529
471
469
530
470
class TestRemoveEnv(
531
471
        EnvDataTestsMixin, helpers.ValueErrorTestsMixin, unittest.TestCase):
532
472
533
473
    def test_removal(self):
534
474
        # An environment is successfully removed from the environments db.
535
475
        envs.remove_env(self.env_db, 'aws')
536
476
        environments = self.env_db['environments']
537
477
        self.assertNotIn('aws', environments)
538
478
        # The other environments are not removed.
539
479
        self.assertIn('lxc', environments)
540
480
        # The default environment is not modified.
541
481
        self.assertEqual('lxc', self.env_db['default'])
542
482
543
483
    def test_default_environment_removal(self):
544
484
        # An environment is successfully removed even if it is the default one.
545
485
        envs.remove_env(self.env_db, 'lxc')
546
486
        environments = self.env_db['environments']
547
487
        self.assertNotIn('lxc', environments)
548
488
        # The other environments are not removed.
549
489
        self.assertIn('aws', environments)
550
490
        # The environments database no longer includes a default environment.
551
491
        self.assertNotIn('default', self.env_db)
552
492
553
493
    def test_invalid_environment_name(self):
554
494
        # A ValueError is raised if the environment is not present in env_db.
555
495
        expected = "the environment named u'no-such' does not exist"
556
496
        with self.assert_value_error(expected):
557
497
            envs.remove_env(self.env_db, 'no-such')
558
498
559
499
560
472
class TestGetEnvTypeDb(unittest.TestCase):
500
class TestGetEnvTypeDb(unittest.TestCase):
561
473
501
562
474
    def setUp(self):
502
    def setUp(self):
Status:	Merged
Merged at revision:	40
Proposed branch:	lp:~frankban/juju-quickstart/env-manage-remove-environment
Merge into:	lp:juju-quickstart
Diff against target:	562 lines (+322/-39) 7 files modified quickstart/cli/ui.py (+67/-0) quickstart/cli/views.py (+22/-2) quickstart/models/envs.py (+15/-0) quickstart/tests/cli/helpers.py (+35/-0) quickstart/tests/cli/test_ui.py (+70/-0) quickstart/tests/cli/test_views.py (+79/-31) quickstart/tests/models/test_envs.py (+34/-6)
To merge this branch:	bzr merge lp:~frankban/juju-quickstart/env-manage-remove-environment
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Juju GUI Hackers		2013-12-19	Pending
Review via email: mp+199698@code.launchpad.net