Merge lp:~fginther/charms/trusty/jenkaas/configure-slaves into lp:~canonical-ci-engineering/charms/trusty/jenkaas/trunk

[Francis Ginther]

Adds a slave_manager to connect other nodes via the jenkaas-slave relation.

Adds a slave_manager to connect other nodes via the jenkaas-slave relation.

Configuring a slave requires the jenkins service to be running (and not just starting up). I didn't think this fit well with the existing service manager as all of those actions should take place while the service is stopped. So, I created a separate service manager, slave_manager, specifically for handling actions as a result of relation changes. This charm only supports a single relation (jenkaas-slave) so it's assumed that this is the relation being managed.

The InRelation and NotInRelation classes were created to fit within the service managers "required_data" usage.

[lp:~fginther/charms/trusty/jenkaas/configure-slaves]

11. By Francis Ginther on 2015-06-22

Remove debug logging.

[Joe Talbott (joetalbott)]

I'm not a fan of the InRelation and NotInRelation classes (since they are essentially a method call) but if that's the only way then so be it.

review: Approve

[Para Siva (psivaa)]

Looks good except an inline comment about an unused import.

A little bit curious about if we could not use 'start' callbacks in the first ServiceManager instance for creating the slave. By then the service will have started, i guess.

review: Approve

[lp:~fginther/charms/trusty/jenkaas/configure-slaves]

12. By Francis Ginther on 2015-06-23

flake8 cleanup.

[Francis Ginther (fginther)]

> I'm not a fan of the InRelation and NotInRelation classes (since they are
> essentially a method call) but if that's the only way then so be it.

I dug some more on this and think I can see a way to do this inside the 'data_ready' list directly without creating the separate class. Let me see if I can get this to work while resolving the merge conflicts.

[Francis Ginther (fginther)]

> Looks good except an inline comment about an unused import.

Thanks. Ran flake8 and resolved 2 issues including the unused import.

> A little bit curious about if we could not use 'start' callbacks in the first
> ServiceManager instance for creating the slave. By then the service will have
> started, i guess.

Adding 'start' callbacks would be a way to make sure configure_slaves only runs after the jenkins service is started, but there would have to be a delay between the two as it takes jenkins a few seconds to be responsive. If this becomes a problem for the slave_manager, it could be addressed by adding a 'required_data' callback to ensure that jenkins is started and responding. After working with this for a while, I think it's easier to keep the relation and non-relation hooks handled separately, you don't need to re-install plugins when adding a slave for example.

[Para Siva (psivaa)]

> Adding 'start' callbacks would be a way to make sure configure_slaves only
> runs after the jenkins service is started, but there would have to be a delay
> between the two as it takes jenkins a few seconds to be responsive. If this
> becomes a problem for the slave_manager, it could be addressed by adding a
> 'required_data' callback to ensure that jenkins is started and responding.
> After working with this for a while, I think it's easier to keep the relation
> and non-relation hooks handled separately, you don't need to re-install
> plugins when adding a slave for example.
This makes a lot of sense. Thanks for the explanation. +1 from me.

Unmerged revisions

12. By Francis Ginther on 2015-06-23

flake8 cleanup.

11. By Francis Ginther on 2015-06-22

Remove debug logging.

10. By Francis Ginther on 2015-06-22

Remove broken and changed hooks as they are just repeating the departed and joined events and clean up the code around creating and deleting a node.

9. By Francis Ginther on 2015-06-22

Add missing jenkaas-slave-relation-broken and jenkaas-slave-relation-departed symlinks.

8. By Francis Ginther on 2015-06-19

Create a slave_manager to handle the relations.

7. By Francis Ginther on 2015-06-19

First pass at connecting and disconnecting slaves.

=== modified file 'hooks/actions.py'
--- hooks/actions.py	2015-06-22 16:56:46 +0000
+++ hooks/actions.py	2015-06-23 13:32:12 +0000
@@ -12,10 +12,15 @@
 
 SERVICE_NAME = 'jenkaas'
 SERVICE_CONFIGNAME = 'jenkaas.conf'
+<<<<<<< TREE
 DEPS_PKGES = [
     "daemon", "adduser", "psmisc", "default-jre",
     "pwgen",
     ]
+=======
+DEPS_PKGES = ["daemon", "adduser", "psmisc", "default-jre",
+              "pwgen", "python-jenkins"]
+>>>>>>> MERGE-SOURCE
 
 config = hookenv.config()
 
@@ -63,7 +68,8 @@
     hookenv.log('Installing jenkins config')
     in_config = os.path.join(hookenv.charm_dir(),
                              'files/templates/config.xml')
-    shutil.copy(in_config, _service_dir())
+    if not os.path.exists(os.path.join(_service_dir(), 'config.xml')):
+        shutil.copy(in_config, _service_dir())
 
 
 def configure_default_user(service_name):
@@ -95,6 +101,7 @@
 
 def install_slaves(service_name):
     hookenv.log('Installing slaves')
+<<<<<<< TREE
     hookenv.log(hookenv.relations())
 
 
@@ -129,3 +136,21 @@
 
 def start_jenkins(service_name):
     host.service_start('jenkins')
+=======
+    node = hookenv.remote_unit().replace('/', '-')
+    hookenv.log('Configuring slave: {}'.format(node))
+
+    import jenkins
+    j = jenkins.Jenkins('http://localhost:8080',
+                        username=config['username'],
+                        password=config['password'])
+
+    if (hookenv.hook_name().endswith('joined') or
+            hookenv.hook_name().endswith('changed')):
+        hookenv.log('Creating slave: {}'.format(node))
+        j.create_node(node,
+                      launcher='hudson.slaves.JNLPLauncher')
+    else:
+        hookenv.log('Deleting slave: {}'.format(node))
+        j.delete_node(node)
+>>>>>>> MERGE-SOURCE
 
=== removed symlink 'hooks/jenkaas-slave-relation-changed'
=== target was u'hooks.py'
=== added symlink 'hooks/jenkaas-slave-relation-departed'
=== target is u'hooks.py'
=== modified file 'hooks/services.py'
--- hooks/services.py	2015-06-22 16:56:46 +0000
+++ hooks/services.py	2015-06-23 13:32:12 +0000
@@ -14,10 +14,34 @@
     def provide_data(self):
         return {
             'master-address': hookenv.unit_get('private-address'),
-            'port': 8080,
+            'username': hookenv.config('username'),
+            'password': hookenv.config('password'),
         }
 
 
+class InRelation(dict):
+    '''This is used to seprate the hooks into relation and non-relation.'''
+    def __init__(self):
+        hookenv.log('InRelation: {}'.format(hookenv.in_relation_hook()))
+
+    def __bool__(self):
+        return hookenv.in_relation_hook()
+
+    __nonzero__ = __bool__
+
+
+class NotInRelation(dict):
+    '''This is used to seprate the hooks into relation and non-relation.'''
+    def __init__(self):
+        hookenv.log('InRelation: {}'.format(hookenv.in_relation_hook()))
+
+    def __bool__(self):
+        hookenv.log('NotInRelation: {}'.format(not hookenv.in_relation_hook()))
+        return not hookenv.in_relation_hook()
+
+    __nonzero__ = __bool__
+
+
 def manage():
     config = hookenv.config()
     manager = ServiceManager([
@@ -25,6 +49,7 @@
             'service': 'jenkaas',
             'required_data': [
                 config,
+                NotInRelation(),
             ],
             'provided_data': [MasterToSlaveProvider()],
             'data_ready': [
@@ -37,11 +62,30 @@
                 actions.create_example_job,
                 actions.install_jenkins_config,
                 actions.configure_default_user,
+<<<<<<< TREE
                 actions.install_slaves,
+=======
+                render_template(
+                    source='upstart.conf',
+                    target='/etc/init/jenkaas.conf'),
+>>>>>>> MERGE-SOURCE
                 actions.log_start,
             ],
             'start': actions.start_jenkins,
             'ports': [8080],
         },
     ])
+    slave_manager = ServiceManager([
+        {
+            'service': 'jenkaas',
+            'required_data': [
+                config,
+                InRelation(),
+            ],
+            'data_ready': [
+                actions.install_slaves,
+            ],
+        },
+    ])
     manager.manage()
+    slave_manager.manage()