Merge charm-k8s-jenkins-agent:manual-agent into charm-k8s-jenkins-agent:master

[Alexandre Gomes]

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Unable to determine commit message from repository - please click "Set commit message" and enter the commit message manually.

[Tom Haddon (mthaddon)]

We're missing a commit message for this MP, so it wouldn't let us merge yet.

I've included some comments inline, but also I had to make the following changes to get lint and tests to run (`make test`) https://paste.ubuntu.com/p/j3tSHmbmcB/

review: Needs Fixing

[Alexandre Gomes (alejdg)]

> We're missing a commit message for this MP, so it wouldn't let us merge yet.
>
> I've included some comments inline, but also I had to make the following
> changes to get lint and tests to run (`make test`)
> https://paste.ubuntu.com/p/j3tSHmbmcB/

I addressed all the comments but two:

- The term "master" isn't going away as per their blog post[1], only "slave". So I think we should follow the same terms Jenkins devs are using.
- The interface is still called jenkins-slave, so we should keep that until we update the interface.

review: Needs Resubmitting

[Alexandre Gomes (alejdg)]

All changes in this MP can be found in https://code.launchpad.net/~jenkins-ci-charmers/charm-k8s-jenkins-agent/+git/charm-k8s-jenkins-agent/+merge/389685 as it superseeds this.

[Alexandre Gomes (alejdg)]

I forgot to provide the link to the blog post:
https://www.jenkins.io/blog/2020/05/06/docker-agent-image-renaming/#why

Unmerged commits

9ba35a0... by Alexandre Gomes on 2020-07-29

Improve the charm so it can work properly with juju config and add unit

79d2ac2... by Alexandre Gomes on 2020-07-29

Fix redeployment issues and make the charm not scalable

0d8faa5... by Alexandre Gomes on 2020-07-28

Save agent's secret in a dictionary instead

1ca7e4b... by Alexandre Gomes on 2020-07-22

Address comments and make use of the secret provided by jenkins through relation

8e2d166... by Alexandre Gomes on 2020-05-01

Fix logging

4f4c6cb... by Alexandre Gomes on 2020-05-01

Add slave_relation_joined

0eea73b... by Alexandre Gomes on 2020-04-30

Create on_jenkins_relation_joined event

dcfe2f6... by Alexandre Gomes on 2020-04-29

Add initial jenkins-slave relation

diff --git a/Makefile b/Makefile
index 86bd8d3..8c8056a 100644
--- a/Makefile
+++ b/Makefile
@@ -18,6 +18,13 @@ build-image: | $(dockerfile_dir)
 	  --build-arg REVISION="$(revision)" \
 	  -t $(JENKINS_IMAGE) $(dockerfile_dir)
 
+build-image-no-cache: | $(dockerfile_dir)
+	docker build \
+	  --build-arg AUTHOR=$(author) \
+	  --build-arg REVISION="$(revision)" \
+	  --no-cache \
+	  -t $(JENKINS_IMAGE) $(dockerfile_dir)
+
 build-release-image: | $(dockerfile_dir)
 	docker build \
 	  --build-arg DATE_CREATED="$(date_created)" \
diff --git a/dockerfile/Dockerfile b/dockerfile/Dockerfile
index 1abd7e6..e03339f 100644
--- a/dockerfile/Dockerfile
+++ b/dockerfile/Dockerfile
@@ -47,7 +47,8 @@ RUN apt-get update -y \
 
 WORKDIR /var/lib/jenkins
 
-USER ${USER}
+#USER ${USER}
+USER root
 
 COPY files/entrypoint.sh /
 
diff --git a/dockerfile/files/entrypoint.sh b/dockerfile/files/entrypoint.sh
index c4e879c..c8ece01 100755
--- a/dockerfile/files/entrypoint.sh
+++ b/dockerfile/files/entrypoint.sh
@@ -3,6 +3,7 @@
 set -eu -o pipefail
 
 export LC_ALL=C
+export TERM=xterm
 
 # defaults for jenkins-agent component of the jenkins continuous integration
 # system
@@ -25,11 +26,15 @@ typeset JENKINS_URL="${JENKINS_URL:?"URL of a jenkins server must be provided"}"
 # hostname of the server the agent is running on.
 typeset JENKINS_HOSTNAME="${JENKINS_HOSTNAME:-$(hostname)}"
 
+
+typeset JENKINS_WORKDIR="/var/lib/jenkins"
+
 # Arguments to pass to jenkins agent on startup
 typeset -a JENKINS_ARGS
 
-JENKINS_ARGS+=(-jnlpUrl "${JENKINS_URL}"/computer/"${JENKINS_HOSTNAME}"/slave-agent.jnlp)
-JENKINS_ARGS+=(-jnlpCredentials "${JENKINS_API_USER:?Please specify JENKINS_API_USER}:${JENKINS_API_TOKEN:?Please specify JENKINS_API_TOKEN}")
+# JENKINS_ARGS+=(-jnlpUrl "${JENKINS_URL}"/computer/"${JENKINS_HOSTNAME}"/slave-agent.jnlp)
+# JENKINS_ARGS+=(-jnlpCredentials "${JENKINS_API_USER:?Please specify JENKINS_API_USER}:${JENKINS_API_TOKEN:?Please specify JENKINS_API_TOKEN}")
+# JENKINS_ARGS+=(-noReconect)
 
 # Path of the agent.jar
 typeset AGENT_JAR=/var/lib/jenkins/agent.jar
@@ -56,4 +61,21 @@ download_agent
 touch /var/lib/jenkins/agents/.ready
 
 #shellcheck disable=SC2086
-"${JAVA}" ${JAVA_ARGS} -jar "${AGENT_JAR}"  "${JENKINS_ARGS[@]}"
+# "${JAVA}" ${JAVA_ARGS} -jar "${AGENT_JAR}"  "${JENKINS_ARGS[@]}"
+
+# Transform the env variables in arrays to iterate through it
+IFS=':' read -r -a AGENTS <<< ${JENKINS_AGENTS}
+IFS=':' read -r -a TOKENS <<< ${JENKINS_TOKENS}
+
+echo ${!AGENTS[@]}
+
+for index in ${!AGENTS[@]}; do
+    echo "agent  : ${AGENTS[$index]}"
+    echo "value: ${TOKENS[$index]}"
+    echo "${JAVA}" "${JAVA_ARGS}" -jar "${AGENT_JAR}" -jnlpUrl "${JENKINS_URL}"/computer/"${AGENTS[$index]}"/slave-agent.jnlp -workDir "${JENKINS_WORKDIR}" -noReconnect -secret "${TOKENS[$index]}"
+    ${JAVA} ${JAVA_ARGS} -jar ${AGENT_JAR} -jnlpUrl ${JENKINS_URL}/computer/${AGENTS[$index]}/slave-agent.jnlp -workDir ${JENKINS_WORKDIR} -noReconnect -secret ${TOKENS[$index]} || echo "Invalid or already used credentials." || True
+    # ${JAVA} ${JAVA_ARGS} -jar ${AGENT_JAR} -jnlpUrl ${JENKINS_URL}/computer/${AGENTS[$index]}/slave-agent.jnlp -workDir ${JENKINS_WORKDIR} -noReconnect -secret ${TOKENS[$index]} || tail -f /dev/null
+done
+echo "Tail End"
+tail -f /dev/null
+echo "Tail After End"
\ No newline at end of file
diff --git a/metadata.yaml b/metadata.yaml
index b53a613..dd92ccb 100644
--- a/metadata.yaml
+++ b/metadata.yaml
@@ -9,3 +9,6 @@ series:
   - kubernetes
 deployment:
   service: omit
+provides:
+  slave:
+    interface: jenkins-slave
diff --git a/src/charm.py b/src/charm.py
index 4ba8782..ea6d681 100755
--- a/src/charm.py
+++ b/src/charm.py
@@ -5,10 +5,14 @@
 
 import io
 import pprint
+import os
+import sys
 import logging
 
+sys.path.append('lib')  # noqa: E402
+
 from ops.charm import CharmBase
-from ops.framework import StoredState
+from ops.framework import StoredState, EventSource, EventBase
 from ops.main import main
 from ops.model import ActiveStatus, BlockedStatus, MaintenanceStatus
 
@@ -16,32 +20,10 @@ from ops.model import ActiveStatus, BlockedStatus, MaintenanceStatus
 logger = logging.getLogger()
 
 
-def generate_pod_config(config, secured=True):
-    """Kubernetes pod config generator.
-
-    generate_pod_config generates Kubernetes deployment config.
-    If the secured keyword is set then it will return a sanitised copy
-    without exposing secrets.
-    """
-    pod_config = {}
-
-    pod_config["JENKINS_API_USER"] = config["jenkins_user"]
-    if config.get("jenkins_master_url", None):
-        pod_config["JENKINS_URL"] = config["jenkins_master_url"]
-    if config.get("jenkins_agent_name", None):
-        pod_config["JENKINS_HOSTNAME"] = config["jenkins_agent_name"]
-
-    if secured:
-        return pod_config
-
-    # Add secrets from charm config
-    pod_config["JENKINS_API_TOKEN"] = config["jenkins_api_token"]
-
-    return pod_config
-
-
 class JenkinsAgentCharm(CharmBase):
-    state = StoredState()
+    _stored = StoredState()
+
+    # on_slave_relation_configured = EventSource(SlaveRelationConfigureEvent)
 
     def __init__(self, framework, parent):
         super().__init__(framework, parent)
@@ -49,8 +31,10 @@ class JenkinsAgentCharm(CharmBase):
         framework.observe(self.on.start, self.configure_pod)
         framework.observe(self.on.config_changed, self.configure_pod)
         framework.observe(self.on.upgrade_charm, self.configure_pod)
+        framework.observe(self.on.slave_relation_joined, self.on_slave_relation_joined)
+        framework.observe(self.on.slave_relation_changed, self.on_slave_relation_changed)
 
-        self.state.set_default(_spec=None)
+        self._stored.set_default(_spec=None, jenkins_url=None, agent_tokens=None, agents=None)
 
     def on_upgrade_charm(self, event):
         pass
@@ -58,14 +42,52 @@ class JenkinsAgentCharm(CharmBase):
     def on_config_changed(self, event):
         pass
 
+    def generate_pod_config(self, config, secured=True):
+        """Kubernetes pod config generator.
+
+        generate_pod_config generates Kubernetes deployment config.
+        If the secured keyword is set then it will return a sanitised copy
+        without exposing secrets.
+        """
+        pod_config = {}
+
+        pod_config["JENKINS_API_USER"] = config["jenkins_user"]
+
+        if self._stored.jenkins_url:
+            pod_config["JENKINS_URL"] = self._stored.jenkins_url
+        elif config.get("jenkins_master_url", None):
+            pod_config["JENKINS_URL"] = config["jenkins_master_url"]
+        if config.get("jenkins_agent_name", None):
+            pod_config["JENKINS_HOSTNAME"] = config["jenkins_agent_name"]
+
+        if secured:
+            return pod_config
+
+        # pod_config["JENKINS_API_TOKEN"] = self._stored.agent_tokens or config["jenkins_api_token"]
+        if self._stored.agent_tokens and self._stored.agents:
+            # for agent in self._stored.agents:
+            #     logger.info("ALEJDG - generate_pod_config - self._stored.agent: %s", agent)
+            logger.info("ALEJDG - generate_pod_config - self._stored.agent: %s", self._stored.agents)
+            # pod_config["JENKINS_AGENTS"] = ":".join(self._stored.agents)
+            pod_config["JENKINS_AGENTS"] = ":".join(self._stored.agents)
+            pod_config["JENKINS_TOKENS"] = ":".join(self._stored.agent_tokens)
+        else:
+            pod_config["JENKINS_TOKENS"] = config["jenkins_api_token"]
+
+        return pod_config
+
     def configure_pod(self, event):
         is_valid = self.is_valid_config()
         if not is_valid:
             return
 
+        if not self.unit.is_leader():
+            self.unit.status = ActiveStatus()
+            return
+
         spec = self.make_pod_spec()
-        if spec != self.state._spec:
-            self.state._spec = spec
+        if spec != self._stored._spec:
+            self._stored._spec = spec
             # only the leader can set_spec()
             if self.model.unit.is_leader():
                 spec = self.make_pod_spec()
@@ -81,13 +103,15 @@ class JenkinsAgentCharm(CharmBase):
         else:
             logger.info("Pod spec unchanged")
 
-        self.state.is_started = True
+        self._stored.is_started = True
         self.model.unit.status = ActiveStatus()
 
     def make_pod_spec(self):
         config = self.model.config
-        full_pod_config = generate_pod_config(config, secured=False)
-        secure_pod_config = generate_pod_config(config, secured=True)
+        logger.info("ALEJDG - config type: %s - config data: %s", type(config), config)
+
+        full_pod_config = self.generate_pod_config(config, secured=False)
+        secure_pod_config = self.generate_pod_config(config, secured=True)
 
         spec = {
             "containers": [
@@ -101,18 +125,23 @@ class JenkinsAgentCharm(CharmBase):
         }
 
         out = io.StringIO()
-        pprint.pprint(spec, out)
         logger.info("This is the Kubernetes Pod spec config (sans secrets) <<EOM\n{}\nEOM".format(out.getvalue()))
 
         secure_pod_config.update(full_pod_config)
+        pprint.pprint(spec, out)
+        logger.info("This is the Kubernetes Pod spec config (with secrets) <<EOM\n{}\nEOM".format(out.getvalue()))
 
         return spec
 
     def is_valid_config(self):
         is_valid = True
-        config = self.model.config
 
-        want = ("image", "jenkins_user", "jenkins_api_token")
+        config = self.model.config
+        logger.info("ALEJDG SPEC: %s", self._stored._spec)
+        if self._stored.agent_tokens:
+            want = ("image", "jenkins_user")
+        else:
+            want = ("image", "jenkins_user", "jenkins_api_token")
         missing = [k for k in want if config[k].rstrip() == ""]
         if missing:
             message = "Missing required config: {}".format(" ".join(missing))
@@ -122,6 +151,97 @@ class JenkinsAgentCharm(CharmBase):
 
         return is_valid
 
+    def on_slave_relation_joined(self, event):
+        logger.info("Jenkins relation joined")
+        noexecutors = os.cpu_count()
+        config_labels = self.model.config.get('labels')
+        agent_name = ""
+        if self._stored.agents:
+            self._stored.agents[-1]
+            name, number = self._stored.agents[-1].rsplit('-', 1)
+            agent_name = "{}-{}".format(name, int(number) + 1)
+        else:
+            self._stored.agents = []
+            agent_name = self.unit.name.replace('/', '-')
+
+        if config_labels:
+            labels = config_labels
+        else:
+            labels = os.uname()[4]
+
+        # slave_address = hookenv.unit_private_ip()
+
+        logger.info("noexecutors: %s - type: %s", noexecutors, type(noexecutors))
+        logger.info("labels: %s - type: %s",labels, type(labels))
+        event.relation.data[self.model.unit]["executors"] = str(noexecutors)
+        event.relation.data[self.model.unit]["labels"] = labels
+        event.relation.data[self.model.unit]["slavehost"] = agent_name
+
+        remote_data = event.relation.data[event.app]
+        logger.info("ALEJDG - remote_data_app: %s", remote_data)
+        for i in remote_data:
+            logger.info("ALEJDG - remote_data_app['%s']: %s", i, remote_data[i])
+
+        if event.unit is not None:
+            remote_data = event.relation.data[event.unit]
+            logger.info("ALEJDG - os.environ: %s", os.environ)
+
+        logger.info("ALEJDG - remote_data_post_app: %s", remote_data)
+        for i in remote_data:
+            logger.info("ALEJDG - remote_data_post_app['%s']: %s", i, remote_data[i])
+
+    def on_slave_relation_changed(self, event):
+        logger.info("Jenkins relation changed")
+        try:
+            logger.info("ALEJDG - event.relation.data[event.unit]['url']: %s", event.relation.data[event.unit]['url'])
+            self._stored.jenkins_url = event.relation.data[event.unit]['url']
+        except KeyError:
+            pass
+
+        try:
+            logger.info("ALEJDG - event.relation.data[event.unit]['secret']: %s", event.relation.data[event.unit]['secret'])
+            logger.info("ALEJDG - event.unit.name: %s", event.unit.name)
+            logger.info("ALEJDG - self.unit.name.: %s", self.unit.name)
+            self._stored.agent_tokens = self._stored.agent_tokens or []
+            self._stored.agent_tokens.append(event.relation.data[event.unit]['secret'])
+            agent_name = ""
+            if self._stored.agents:
+                logger.info("ALEJDG - self._stored.agents[-1]: %s", self._stored.agents[-1])
+                self._stored.agents[-1]
+                name, number = self._stored.agents[-1].rsplit('-', 1)
+                agent_name = "{}-{}".format(name, int(number) + 1)
+                self._stored.agents.append(agent_name)
+            else:
+                self._stored.agents = []
+                agent_name = self.unit.name.replace('/', '-')
+                self._stored.agents.append(agent_name)
+        except KeyError:
+            pass
+
+        self.configure_slave_through_relation(event)
+
+    def configure_slave_through_relation(self, event):
+        logger.info("Setting up jenkins via slave relation")
+        logger.info("ALEJDG - on_slave_relation_joined - self._stored.agents_setup: %s", self._stored.agents)
+        self.model.unit.status = MaintenanceStatus("Configuring jenkins agent")
+
+        if self.model.config.get("url"):
+            logger.info("Config option 'url' is set. Can't use agent relation.")
+            self.model.unit.status = ActiveStatus()
+            return
+
+        if self._stored.jenkins_url is None:
+            logger.info("Jenkins hasn't exported its url yet. Skipping setup for now.")
+            self.model.unit.status = ActiveStatus()
+            return
+
+        if self._stored.agent_tokens is None:
+            logger.info("Jenkins hasn't exported the agent secret yet. Skipping setup for now.")
+            self.model.unit.status = ActiveStatus()
+            return
+
+        self.configure_pod(event)
+
 
 if __name__ == '__main__':
     main(JenkinsAgentCharm)
diff --git a/src/interface_jenkins_slave.py b/src/interface_jenkins_slave.py
new file mode 100644
index 0000000..dec278d
--- /dev/null
+++ b/src/interface_jenkins_slave.py
@@ -0,0 +1,66 @@
+import json
+
+from ops.framework import EventBase, EventsBase, EventSource, Object, StoredState
+
+
+class NewClient(EventBase):
+    def __init__(self, handle, client):
+        super().__init__(handle)
+        self.client = client
+
+    def snapshot(self):
+        return {
+            'relation_name': self.client._relation.name,
+            'relation_id': self.client._relation.id,
+        }
+
+    def restore(self, snapshot):
+        relation = self.model.get_relation(snapshot['relation_name'], snapshot['relation_id'])
+        self.client = HTTPInterfaceClient(relation, self.model.unit)
+
+
+class HTTPServerEvents(EventsBase):
+    new_client = EventSource(NewClient)
+
+
+class HTTPServer(Object):
+    on = HTTPServerEvents()
+    state = StoredState()
+
+    def __init__(self, charm, relation_name):
+        super().__init__(charm, relation_name)
+        self.relation_name = relation_name
+        self.framework.observe(charm.on.start, self.init_state)
+        self.framework.observe(charm.on[relation_name].relation_joined, self.on_joined)
+        self.framework.observe(charm.on[relation_name].relation_departed, self.on_departed)
+
+    def init_state(self, event):
+        self.state.apps = []
+
+    @property
+    def _relations(self):
+        return self.model.relations[self.relation_name]
+
+    def on_joined(self, event):
+        if event.app not in self.state.apps:
+            self.state.apps.append(event.app)
+            self.on.new_client.emit(HTTPInterfaceClient(event.relation, self.model.unit))
+
+    def on_departed(self, event):
+        self.state.apps = [app for app in self._relations]
+
+    def clients(self):
+        return [HTTPInterfaceClient(relation, self.model.unit) for relation in self._relations]
+
+
+class HTTPInterfaceClient:
+    def __init__(self, relation, local_unit):
+        self._relation = relation
+        self._local_unit = local_unit
+        self.ingress_address = relation.data[local_unit]['ingress-address']
+
+    def serve(self, hosts, port):
+        self._relation.data[self._local_unit]['extended_data'] = json.dumps([{
+            'hostname': host,
+            'port': port,
+        } for host in hosts])
\ No newline at end of file