Integration tests for COS integration for OpenStack

.github/workflows/e2e_test_run.yaml

@@ -21,7 +21,7 @@ on:
 jobs:
   e2e-test:
     name: End-to-End Test Run
-    runs-on: [self-hosted, linux, x64, "${{ inputs.runner-tag }}"]
+    runs-on: [self-hosted, linux, "${{ inputs.runner-tag }}"]
     steps:
       # Snapd can have some issues in privileged LXD containers without setting
       # security.nesting=True and this.

.github/workflows/integration_test.yaml

@@ -1,8 +1,7 @@
 name: integration-tests
 
 on:
-  # TODO: Re-enable
-  # pull_request:
+  pull_request:
   workflow_dispatch:
 
 jobs:

.github/workflows/push_test.yaml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   push-event-tests:
-    runs-on: [self-hosted, linux, x64, "${{ github.ref_name }}"]
+    runs-on: [self-hosted, linux, "${{ github.ref_name }}"]
     steps:
       - name: Echo runner name
         run: |

.github/workflows/schedule_issues_test.yaml

@@ -19,7 +19,7 @@ jobs:
 
   issues-schedule-event-tests:
     needs: [ extract-runner-name ]
-    runs-on: [ self-hosted, linux, x64, "${{ needs.extract-runner-name.outputs.name }}" ]
+    runs-on: [ self-hosted, linux, "${{ needs.extract-runner-name.outputs.name }}" ]
     steps:
       - name: Echo runner name
         run: |

.github/workflows/workflow_dispatch_crash_test.yaml

@@ -10,7 +10,7 @@ on:
 
 jobs:
   workflow-dispatch-tests:
-    runs-on: [self-hosted, linux, x64, "${{ inputs.runner }}"]
+    runs-on: [self-hosted, linux, "${{ inputs.runner }}"]
     steps:
       - name: Sleep for an hour to give the integration test some time to crash the runner.
         run: |

.github/workflows/workflow_dispatch_failure_test.yaml

@@ -13,7 +13,7 @@ on:
 
 jobs:
   workflow-dispatch-tests:
-    runs-on: [self-hosted, linux, x64, "${{ inputs.runner }}"]
+    runs-on: [self-hosted, linux, "${{ inputs.runner }}"]
     steps:
       - name: Echo input variable and message
         run: |

.github/workflows/workflow_dispatch_ssh_debug.yaml

@@ -10,7 +10,7 @@ on:
 
 jobs:
   workflow-dispatch-tests:
-    runs-on: [self-hosted, linux, x64, "${{ inputs.runner }}"]
+    runs-on: [self-hosted, linux, "${{ inputs.runner }}"]
     steps:
     - name: Setup tmate session
       uses: canonical/action-tmate@chore/env_var_change

.github/workflows/workflow_dispatch_test.yaml

@@ -10,7 +10,7 @@ on:
 
 jobs:
   workflow-dispatch-tests:
-    runs-on: [self-hosted, linux, x64, "${{ inputs.runner }}"]
+    runs-on: [self-hosted, linux, "${{ inputs.runner }}"]
     steps:
       - name: Echo input variable and message
         run: |

.github/workflows/workflow_dispatch_wait_test.yaml

@@ -15,7 +15,7 @@ on:
 
 jobs:
   workflow-dispatch-tests:
-    runs-on: [self-hosted, linux, x64, "${{ inputs.runner }}"]
+    runs-on: [self-hosted, linux, "${{ inputs.runner }}"]
     steps:
       - name: Echo input variable and message
         run: |

pyproject.toml

@@ -29,6 +29,9 @@ show_missing = true
 [tool.pytest.ini_options]
 minversion = "6.0"
 log_cli_level = "INFO"
+markers = [
+    "openstack: mark a test as applicable for openstack cloud",
+]
 
 [tool.pylint.'MESSAGES CONTROL']
 extension-pkg-whitelist = "pydantic"

src-docs/openstack_manager.md

@@ -16,7 +16,7 @@ Module for handling interactions with OpenStack.
 
 ---
 
-<a href="../src/openstack_cloud/openstack_manager.py#L343"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/openstack_cloud/openstack_manager.py#L344"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `build_image`
 
@@ -56,7 +56,7 @@ Build and upload an image to OpenStack.
 
 ---
 
-<a href="../src/openstack_cloud/openstack_manager.py#L402"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/openstack_cloud/openstack_manager.py#L403"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `create_instance_config`
 
@@ -92,7 +92,7 @@ Create an instance config from charm data.
 
 ---
 
-<a href="../src/openstack_cloud/openstack_manager.py#L116"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/openstack_cloud/openstack_manager.py#L117"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>class</kbd> `InstanceConfig`
 The configuration values for creating a single runner instance. 
@@ -131,7 +131,7 @@ __init__(
 
 ---
 
-<a href="../src/openstack_cloud/openstack_manager.py#L191"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/openstack_cloud/openstack_manager.py#L192"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>class</kbd> `ProxyStringValues`
 Wrapper class to proxy values to string. 
@@ -150,7 +150,7 @@ Wrapper class to proxy values to string.
 
 ---
 
-<a href="../src/openstack_cloud/openstack_manager.py#L299"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/openstack_cloud/openstack_manager.py#L300"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>class</kbd> `OpenstackUpdateImageError`
 Represents an error while updating image on Openstack. 
@@ -161,7 +161,7 @@ Represents an error while updating image on Openstack.
 
 ---
 
-<a href="../src/openstack_cloud/openstack_manager.py#L496"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/openstack_cloud/openstack_manager.py#L497"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>class</kbd> `GithubRunnerRemoveError`
 Represents an error removing registered runner from Github. 
@@ -172,7 +172,7 @@ Represents an error removing registered runner from Github.
 
 ---
 
-<a href="../src/openstack_cloud/openstack_manager.py#L504"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/openstack_cloud/openstack_manager.py#L505"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>class</kbd> `OpenstackRunnerManager`
 Runner manager for OpenStack-based instances. 
@@ -185,7 +185,7 @@ Runner manager for OpenStack-based instances.
  - <b>`unit_num`</b>:  The juju unit number. 
  - <b>`instance_name`</b>:  Prefix of the name for the set of runners. 
 
-<a href="../src/openstack_cloud/openstack_manager.py#L513"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/openstack_cloud/openstack_manager.py#L514"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `__init__`
 
@@ -214,7 +214,7 @@ Construct OpenstackRunnerManager object.
 
 ---
 
-<a href="../src/openstack_cloud/openstack_manager.py#L1276"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/openstack_cloud/openstack_manager.py#L1279"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `flush`
 
@@ -231,7 +231,7 @@ Flush Openstack servers.
 
 ---
 
-<a href="../src/openstack_cloud/openstack_manager.py#L856"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/openstack_cloud/openstack_manager.py#L859"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `get_github_runner_info`
 
@@ -248,7 +248,7 @@ Get information on GitHub for the runners.
 
 ---
 
-<a href="../src/openstack_cloud/openstack_manager.py#L1179"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="../src/openstack_cloud/openstack_manager.py#L1182"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ### <kbd>method</kbd> `reconcile`
 

src/openstack_cloud/openstack_manager.py

@@ -16,6 +16,7 @@
 """Module for handling interactions with OpenStack."""
 import logging
 import secrets
+import shutil
 import time
 from contextlib import contextmanager
 from dataclasses import dataclass
@@ -638,6 +639,8 @@ def _setup_runner_keypair(conn: OpenstackConnection, name: str) -> None:
 
         keypair = conn.create_keypair(name=name)
         private_key_path.write_text(keypair.private_key)
+        shutil.chown(private_key_path, user="ubuntu", group="ubuntu")
+        private_key_path.chmod(0o400)
 
     @staticmethod
     def _ssh_health_check(server: Server) -> bool:

templates/openstack-userdata.sh.j2

@@ -97,7 +97,6 @@ write_post_metrics(){
 }
 
 # Run runner
-su - ubuntu -c "cd ~/actions-runner && /home/ubuntu/actions-runner/run.sh"
-write_post_metrics $?
+(set +e; su - ubuntu -c "cd ~/actions-runner && /home/ubuntu/actions-runner/run.sh"; write_post_metrics $?)
 
 su - ubuntu -c "touch /home/ubuntu/run-completed"

tests/conftest.py

@@ -57,3 +57,10 @@ def pytest_addoption(parser: Parser):
         action="store",
         help="The OpenStack clouds yaml file for the charm to use.",
     )
+    parser.addoption(
+        "--use-existing-app",
+        action="store",
+        help="The existing app to use. "
+             "This will skip deployment of the charm and use the existing app. "
+             "Useful for local testing.",
+    )