Add 'virsh-audit' action in nova-compute

This new action to list instances as
  virsh sees them on the node (virsh
  list --all), sometimes this disagrees
  with what nova thinks

  Add a new zaza functional test class to
  avoid breaking the older versions

  To run the action, issue command:
  $ juju run-action nova-compute/0 virsh-audit --wait
  unit-nova-compute-0:
  UnitId: nova-compute/0
  id: "134"
  results:
    virsh-domains: |2+
       Id   Name                State
      -----------------------------------
       1    instance-00000001   running
       2    instance-00000002   running
  status: completed
  timing:
    completed: 2020-12-08 11:05:02 +0000 UTC
    enqueued: 2020-12-08 11:04:58 +0000 UTC
    started: 2020-12-08 11:05:01 +0000 UTC

  Closes-Bug: #1907409
  func-test-pr: https://github.com/openstack-charmers/zaza-openstack-tests/pull/472

Change-Id: I222a119199ada82186e2058402a31a40baf7fd7b

actions.yaml

@@ -8,3 +8,5 @@ hugepagereport:
   description: Report on hugepage configuration and usage
 security-checklist:
   description: Validate the running configuration against the OpenStack security guides checklist
+virsh-audit:
+  description: List all domains as virsh sees on the compute node

actions/virsh-audit

@@ -0,0 +1 @@
+virshaudit.py

actions/virshaudit.py

@@ -0,0 +1,55 @@
+#!/usr/bin/env python3
+#
+# Copyright 2020 Canonical Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import sys
+
+_path = os.path.dirname(os.path.realpath(__file__))
+_hooks = os.path.abspath(os.path.join(_path, '../hooks'))
+
+
+def _add_path(path):
+    if path not in sys.path:
+        sys.path.insert(1, path)
+
+
+_add_path(_hooks)
+
+
+import subprocess
+from charmhelpers.core import hookenv
+
+
+def virsh_audit():
+    """
+    Return the list of VM instances as virsh sees on the
+    compute node
+    """
+    outmap = {}
+    cmd = "virsh list --all"
+    try:
+        outmap['virsh-domains'] = subprocess.check_output(
+            cmd, shell=True).decode('UTF-8')
+    except subprocess.CalledProcessError as e:
+        hookenv.log(e)
+        hookenv.action_fail(
+            "Getting virsh list report failed: {}".format(e.message)
+        )
+    hookenv.action_set(outmap)
+
+
+if __name__ == '__main__':
+    virsh_audit()

tests/tests.yaml

@@ -46,6 +46,7 @@ tests:
 - zaza.openstack.charm_tests.nova.tests.CirrosGuestCreateTest
 - zaza.openstack.charm_tests.nova.tests.LTSGuestCreateTest
 - zaza.openstack.charm_tests.nova.tests.NovaCompute
+- zaza.openstack.charm_tests.nova.tests.NovaComputeActionTest
 - zaza.openstack.charm_tests.nova.tests.SecurityTests
 
 tests_options:

unit_tests/test_actions_virsh_audit.py

@@ -0,0 +1,36 @@
+# Copyright 2020 Canonical Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import mock
+from test_utils import CharmTestCase
+import virshaudit as actions
+
+
+class MainTestCase(CharmTestCase):
+    def setUp(self):
+        pass
+
+    @mock.patch('subprocess.check_output')
+    @mock.patch('charmhelpers.core.hookenv.action_set')
+    def test_virsh_audit(self, mock_action_set, mock_check_output):
+        virsh_output = "1    instance-00000001   running"
+        mock_check_output.return_value = virsh_output.encode()
+        dummy_action = []
+        mock_action_set.side_effect = dummy_action.append
+        actions.virsh_audit()
+        self.assertEqual(len(dummy_action), 1)
+        d = dummy_action[0]
+        self.assertIsInstance(d, dict)
+        self.assert_('virsh-domains' in d)
+        self.assertEqual(d['virsh-domains'], virsh_output)