Code reorganization + docs.

Code reorganization + docs.

Reorganize the jenv related code in preparation of the
bootstrap strategy change.

Separate jenv handling from the environments.yaml file
management in models.

As a consequence of only supporting juju >= 1.18 we
can now safely always retrieve the admin-secret from
the jenv file.

Also updated the HACKING docs to include a brief
description of the project structure.

Tests: `make check`.

QA: use quickstart as usual.

https://code.launchpad.net/~frankban/juju-quickstart/code-reorg/+merge/241416

(do not edit description out of merge proposal)

[frankban, 2014-11-11 14:26:26]

Please take a look.

[bac, 2014-11-11 15:37:56]

LGTM.  Will QA now.

https://codereview.appspot.com/169380043/diff/1/HACKING.rst
File HACKING.rst (right):

https://codereview.appspot.com/169380043/diff/1/HACKING.rst#newcode78
HACKING.rst:78: 
A very nice introduction to the code layout.  Thanks for including it.

https://codereview.appspot.com/169380043/diff/1/quickstart/models/jenv.py
File quickstart/models/jenv.py (right):

https://codereview.appspot.com/169380043/diff/1/quickstart/models/jenv.py#new...
quickstart/models/jenv.py:39: def get_value(env_name, *args):
Why did you chose to use *args here instead of a tuple of key names?

https://codereview.appspot.com/169380043/diff/1/quickstart/tests/helpers.py
File quickstart/tests/helpers.py (right):

https://codereview.appspot.com/169380043/diff/1/quickstart/tests/helpers.py#n...
quickstart/tests/helpers.py:156: In the contentx manager block, the JUJU_HOME is
set to the ancestor
typo: contextx

[rharding, 2014-11-11 15:52:36]

Thanks for the update. I just have one forward looking question that doesn't
directly effect this branch but I'm curious about while looking at this branch.

LGTM, no qa

https://codereview.appspot.com/169380043/diff/1/HACKING.rst
File HACKING.rst (right):

https://codereview.appspot.com/169380043/diff/1/HACKING.rst#newcode128
HACKING.rst:128: the code: go have a look!
nice ty

https://codereview.appspot.com/169380043/diff/1/quickstart/app.py
File quickstart/app.py (right):

https://codereview.appspot.com/169380043/diff/1/quickstart/app.py#newcode263
quickstart/app.py:263: Parse the jenv file to retrieve the admin secret.
do you know if we can use the password field in the jenv for this? Next week we
hope to start updating the gui for the new username/password work in juju 1.21
and I know we'll need to update quickstart to pull the username/password from
the jenv file.

https://codereview.appspot.com/169380043/diff/1/quickstart/models/envs.py
File quickstart/models/envs.py (left):

https://codereview.appspot.com/169380043/diff/1/quickstart/models/envs.py#old...
quickstart/models/envs.py:202: def load_generated(env_file,
section='bootstrap-config'):
was this unused?

[bac, 2014-11-11 16:28:56]

Had some QA oddities but it looks OK.

[frankban, 2014-11-11 16:39:37]

Thanks for the reviews!

https://codereview.appspot.com/169380043/diff/1/quickstart/app.py
File quickstart/app.py (right):

https://codereview.appspot.com/169380043/diff/1/quickstart/app.py#newcode263
quickstart/app.py:263: Parse the jenv file to retrieve the admin secret.
On 2014/11/11 15:52:36, rharding wrote:
> do you know if we can use the password field in the jenv for this? Next week
we
> hope to start updating the gui for the new username/password work in juju 1.21
> and I know we'll need to update quickstart to pull the username/password from
> the jenv file. 

With this change it should be easy to grab what we want from the jenv with
jenv.get_value(). We will want to use some fallback logic to support backward
compatibility.
If the user is != user-admin, we will need to update the one-show automatic
authentication with token as well in the guiserver and maybe in the GUI itself.

https://codereview.appspot.com/169380043/diff/1/quickstart/models/envs.py
File quickstart/models/envs.py (left):

https://codereview.appspot.com/169380043/diff/1/quickstart/models/envs.py#old...
quickstart/models/envs.py:202: def load_generated(env_file,
section='bootstrap-config'):
On 2014/11/11 15:52:36, rharding wrote:
> was this unused?

It was used, it is no longer required now.

https://codereview.appspot.com/169380043/diff/1/quickstart/models/jenv.py
File quickstart/models/jenv.py (right):

https://codereview.appspot.com/169380043/diff/1/quickstart/models/jenv.py#new...
quickstart/models/jenv.py:39: def get_value(env_name, *args):
On 2014/11/11 15:37:55, bac wrote:
> Why did you chose to use *args here instead of a tuple of key names?
> 

No real reason actually, I started with just one single key as the argument and
then, after deciding to allow nested keys, it just felt natural.

https://codereview.appspot.com/169380043/diff/1/quickstart/tests/helpers.py
File quickstart/tests/helpers.py (right):

https://codereview.appspot.com/169380043/diff/1/quickstart/tests/helpers.py#n...
quickstart/tests/helpers.py:156: In the contentx manager block, the JUJU_HOME is
set to the ancestor
On 2014/11/11 15:37:55, bac wrote:
> typo: contextx

Done.

[frankban, 2014-11-11 16:41:31]

*** Submitted:

Code reorganization + docs.

Reorganize the jenv related code in preparation of the
bootstrap strategy change.

Separate jenv handling from the environments.yaml file
management in models.

As a consequence of only supporting juju >= 1.18 we
can now safely always retrieve the admin-secret from
the jenv file.

Also updated the HACKING docs to include a brief
description of the project structure.

Tests: `make check`.

QA: use quickstart as usual.

R=bac, rharding
CC=
https://codereview.appspot.com/169380043