[juju] Add juju integration to sos collect.

Add a new cluster profile and transport called "juju" for `sos collect`.
Both the profile and transport are intended to be used on juju managed
environments which assumes that `juju` is installed on the machine where
`sos collect` is called, and that the juju user has superuser privilege
to the current controller.

When using the "juju" cluster profile, the sos reports will be collected
from all the applications within the current model by default. If
necessary, one can filter the nodes by models / applications / units /
machines with cluster options. For example `-c "juju.models=sos" -c
"juju.apps=a,b,c"`. Moreover, transport will also be dynamically changed
to "juju" when cluster type is juju.

If not using "juju" cluster profile, one can still choose to use the
"juju" transport by specifying --transport option. However, not that the
--nodes option will be expected to be a comma separated machine IDs ,
**not** IP addr, since `juju ssh` identifies the ssh target by machine
ID. For example, `sos collect --nodes 0,1,2`

Closes: #2668

Signed-off-by: Chi Wai Chan <chiwai.chan@canonical.com>
Signed-off-by: jneo8 <james.lin@canonical.com>

Co-authored-by: Chi Wai Chan <chiwai.chan@canonical.com>
Co-authored-by: jneo8 <james.lin@canonical.com>

1 files changed, 294 insertions, 0 deletions

diff --git a/tests/unittests/juju/juju_cluster_tests.py b/tests/unittests/juju/juju_cluster_tests.py
new file mode 100644
index 00000000..136dc49f
--- /dev/null
+++ b/tests/unittests/juju/juju_cluster_tests.py
@@ -0,0 +1,294 @@
+# Copyright (c) 2023 Canonical Ltd., Chi Wai Chan <chiwai.chan@canonical.com>
+
+# This file is part of the sos project: https://github.com/sosreport/sos
+#
+# This copyrighted material is made available to anyone wishing to use,
+# modify, copy, or redistribute it subject to the terms and conditions of
+# version 2 of the GNU General Public License.
+#
+# See the LICENSE file in the source distribution for further information.
+import pathlib
+import unittest
+from unittest.mock import call, patch
+
+from sos.collector.clusters.juju import _parse_option_string, juju
+from sos.options import ClusterOption
+
+
+class MockOptions:
+
+    def __init__(self):
+        self.cluster_options = []
+
+
+def get_juju_output(model):
+    dir = pathlib.Path(__file__).parent.resolve()
+    with open(dir / "data" / f"juju_output_{model}.json") as f:
+        return f.read()
+
+
+def get_juju_status(cmd):
+    if "-m" in cmd:
+        model = cmd.split()[3]
+    else:
+        model = "sos"
+
+    return {
+        "status": 0,
+        "output": get_juju_output(model),
+    }
+
+
+def test_parse_option_string():
+    result = _parse_option_string("    a,b,c")
+    assert result == ["a", "b", "c"]
+
+    result = _parse_option_string()
+    assert result == []
+
+
+class JujuTest(unittest.TestCase):
+    """Test for juju cluster."""
+
+    @patch(
+        "sos.collector.clusters.juju.juju.exec_primary_cmd",
+        side_effect=get_juju_status,
+    )
+    def test_get_nodes_no_filter(self, mock_exec_primary_cmd):
+        """No filter."""
+        mock_opts = MockOptions()
+        cluster = juju(
+            commons={
+                "tmpdir": "/tmp",
+                "cmdlineopts": mock_opts,
+            }
+        )
+        nodes = cluster.get_nodes()
+        assert nodes == []
+
+    @patch(
+        "sos.collector.clusters.juju.juju.exec_primary_cmd",
+        side_effect=get_juju_status,
+    )
+    def test_get_nodes_app_filter(self, mock_exec_primary_cmd):
+        """Application filter."""
+        mock_opts = MockOptions()
+        mock_opts.cluster_options.append(
+            ClusterOption(
+                name="apps",
+                opt_type=str,
+                value="ubuntu",
+                cluster=juju.__name__,
+            )
+        )
+        cluster = juju(
+            commons={
+                "tmpdir": "/tmp",
+                "cmdlineopts": mock_opts,
+            }
+        )
+        nodes = cluster.get_nodes()
+        nodes.sort()
+        assert nodes == [":0", ":2", ":3"]
+        mock_exec_primary_cmd.assert_called_once_with(
+            "juju status  --format json"
+        )
+
+    @patch(
+        "sos.collector.clusters.juju.juju.exec_primary_cmd",
+        side_effect=get_juju_status,
+    )
+    def test_get_nodes_app_regex_filter(self, mock_exec_primary_cmd):
+        """Application filter."""
+        mock_opts = MockOptions()
+        mock_opts.cluster_options.append(
+            ClusterOption(
+                name="apps",
+                opt_type=str,
+                value="ubuntu|nginx",
+                cluster=juju.__name__,
+            )
+        )
+        cluster = juju(
+            commons={
+                "tmpdir": "/tmp",
+                "cmdlineopts": mock_opts,
+            }
+        )
+        nodes = cluster.get_nodes()
+        nodes.sort()
+        assert nodes == [":0", ":2", ":3", ":4"]
+        mock_exec_primary_cmd.assert_called_once_with(
+            "juju status  --format json"
+        )
+
+    @patch(
+        "sos.collector.clusters.juju.juju.exec_primary_cmd",
+        side_effect=get_juju_status,
+    )
+    def test_get_nodes_model_filter_multiple_models(
+        self, mock_exec_primary_cmd
+    ):
+        """Multiple model filter."""
+        mock_opts = MockOptions()
+        mock_opts.cluster_options.append(
+            ClusterOption(
+                name="models",
+                opt_type=str,
+                value="sos,sos2",
+                cluster=juju.__name__,
+            ),
+        )
+        mock_opts.cluster_options.append(
+            ClusterOption(
+                name="apps",
+                opt_type=str,
+                value="ubuntu",
+                cluster=juju.__name__,
+            ),
+        )
+        cluster = juju(
+            commons={
+                "tmpdir": "/tmp",
+                "cmdlineopts": mock_opts,
+            }
+        )
+        nodes = cluster.get_nodes()
+        nodes.sort()
+        assert nodes == [
+            "sos2:0",
+            "sos2:1",
+            "sos:0",
+            "sos:2",
+            "sos:3",
+        ]
+        mock_exec_primary_cmd.assert_has_calls(
+            [
+                call("juju status -m sos --format json"),
+                call("juju status -m sos2 --format json"),
+            ]
+        )
+
+    @patch(
+        "sos.collector.clusters.juju.juju.exec_primary_cmd",
+        side_effect=get_juju_status,
+    )
+    def test_get_nodes_model_filter(self, mock_exec_primary_cmd):
+        """Model filter."""
+        mock_opts = MockOptions()
+        mock_opts.cluster_options.append(
+            ClusterOption(
+                name="models",
+                opt_type=str,
+                value="sos",
+                cluster=juju.__name__,
+            )
+        )
+        mock_opts.cluster_options.append(
+            ClusterOption(
+                name="apps",
+                opt_type=str,
+                value="ubuntu",
+                cluster=juju.__name__,
+            ),
+        )
+        cluster = juju(
+            commons={
+                "tmpdir": "/tmp",
+                "cmdlineopts": mock_opts,
+            }
+        )
+        nodes = cluster.get_nodes()
+        nodes.sort()
+        assert nodes == [
+            "sos:0",
+            "sos:2",
+            "sos:3",
+        ]
+        mock_exec_primary_cmd.assert_has_calls(
+            [
+                call("juju status -m sos --format json"),
+            ]
+        )
+
+    @patch(
+        "sos.collector.clusters.juju.juju.exec_primary_cmd",
+        side_effect=get_juju_status,
+    )
+    def test_get_nodes_unit_filter(self, mock_exec_primary_cmd):
+        """Node filter."""
+        mock_opts = MockOptions()
+        mock_opts.cluster_options.append(
+            ClusterOption(
+                name="units",
+                opt_type=str,
+                value="ubuntu/0,ubuntu/1",
+                cluster=juju.__name__,
+            )
+        )
+        cluster = juju(
+            commons={
+                "tmpdir": "/tmp",
+                "cmdlineopts": mock_opts,
+            }
+        )
+        nodes = cluster.get_nodes()
+        nodes.sort()
+        assert nodes == [":0", ":2"]
+
+    @patch(
+        "sos.collector.clusters.juju.juju.exec_primary_cmd",
+        side_effect=get_juju_status,
+    )
+    def test_get_nodes_machine_filter(self, mock_exec_primary_cmd):
+        """Machine filter."""
+        mock_opts = MockOptions()
+        mock_opts.cluster_options.append(
+            ClusterOption(
+                name="machines",
+                opt_type=str,
+                value="0,2",
+                cluster=juju.__name__,
+            )
+        )
+        cluster = juju(
+            commons={
+                "tmpdir": "/tmp",
+                "cmdlineopts": mock_opts,
+            }
+        )
+        nodes = cluster.get_nodes()
+        nodes.sort()
+        print(nodes)
+        assert nodes == [":0", ":2"]
+
+    @patch(
+        "sos.collector.clusters.juju.juju.exec_primary_cmd",
+        side_effect=get_juju_status,
+    )
+    def test_subordinates(self, mock_exec_primary_cmd):
+        """Subordinate filter."""
+        mock_opts = MockOptions()
+        mock_opts.cluster_options.append(
+            ClusterOption(
+                name="apps",
+                opt_type=str,
+                value="nrpe",
+                cluster=juju.__name__,
+            )
+        )
+        cluster = juju(
+            commons={
+                "tmpdir": "/tmp",
+                "cmdlineopts": mock_opts,
+            }
+        )
+        nodes = cluster.get_nodes()
+        nodes.sort()
+        assert nodes == [":0", ":2", ":3"]
+        mock_exec_primary_cmd.assert_called_once_with(
+            "juju status  --format json"
+        )
+
+
+# vim: set et ts=4 sw=4 :