+
## class `OpenStackServerConfig`
Configuration for OpenStack server.
@@ -50,7 +49,7 @@ __init__(image: str, flavor: str, network: str) → None
---
-
+
## class `OpenStackRunnerManagerConfig`
Configuration for OpenStack runner manager.
@@ -93,7 +92,7 @@ __init__(
---
-
+
## class `OpenStackRunnerManager`
Manage self-hosted runner on OpenStack cloud.
@@ -104,7 +103,7 @@ Manage self-hosted runner on OpenStack cloud.
- `name_prefix`: The name prefix of the runners created.
-
+
### method `__init__`
@@ -136,7 +135,7 @@ The prefix of runner names.
---
-
+
### method `cleanup`
@@ -159,7 +158,7 @@ Cleanup runner and resource on the cloud.
---
-
+
### method `create_runner`
@@ -189,7 +188,7 @@ Create a self-hosted runner.
---
-
+
### method `delete_runner`
@@ -213,7 +212,7 @@ Delete self-hosted runners.
---
-
+
### method `flush_runners`
@@ -236,7 +235,7 @@ Remove idle and/or busy runners.
---
-
+
### method `get_runner`
@@ -259,7 +258,7 @@ Get a self-hosted runner by instance id.
---
-
+
### method `get_runners`
diff --git a/github-runner-manager/src/github_runner_manager/openstack_cloud/openstack_runner_manager.py b/github-runner-manager/src/github_runner_manager/openstack_cloud/openstack_runner_manager.py
index 964d98ee5..b0ec2b42f 100644
--- a/github-runner-manager/src/github_runner_manager/openstack_cloud/openstack_runner_manager.py
+++ b/github-runner-manager/src/github_runner_manager/openstack_cloud/openstack_runner_manager.py
@@ -60,7 +60,6 @@
logger = logging.getLogger(__name__)
-BUILD_OPENSTACK_IMAGE_SCRIPT_FILENAME = "scripts/build-openstack-image.sh"
_CONFIG_SCRIPT_PATH = Path("/home/ubuntu/actions-runner/config.sh")
RUNNER_APPLICATION = Path("/home/ubuntu/actions-runner")
diff --git a/metadata.yaml b/metadata.yaml
index d1e0ce9f3..be9160bc2 100644
--- a/metadata.yaml
+++ b/metadata.yaml
@@ -13,7 +13,7 @@ description: |
A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) managing
[self-hosted runners for GitHub Actions](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners).
- Each unit of this charm will start a configurable number of LXD based virtual machines to host
+ Each unit of this charm will start a configurable number of virtual machines to host
self-hosted runners. Each runner performs only one job, after which it unregisters from GitHub to
ensure that each job runs in a clean environment. The charm will periodically check the number of
runners and spawn or destroy them as necessary to maintain the configured number of runners. Both
diff --git a/pyproject.toml b/pyproject.toml
index 8a430a2e7..094aa0bad 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -10,22 +10,13 @@ skips = ["*/*test.py", "*/test_*.py", "*tests/*.py"]
[tool.coverage.run]
branch = true
omit = [
- # These are covered by `tests/integration/test_runner_manager_openstack.py`.
- "src/openstack_cloud/openstack_cloud.py",
- "src/openstack_cloud/openstack_runner_manager.py",
- # Contains interface for calling LXD. Tested in integration tests and end to end tests.
- "src/lxd.py",
# Contains interface for calling repo policy compliance service. Tested in integration test
# and end to end tests.
"src/repo_policy_compliance_client.py",
- # TODO: 2024-04-17: These files are pending a major refactor. The refactor includes a RunnerManager
- # interface class which will include a complete re-organization of the code in these files.
- "src/runner.py",
- "src/runner_manager.py",
]
[tool.coverage.report]
-fail_under = 84
+fail_under = 83
show_missing = true
[tool.pytest.ini_options]
diff --git a/scripts/build-lxd-image.sh b/scripts/build-lxd-image.sh
deleted file mode 100755
index 4feabc0a6..000000000
--- a/scripts/build-lxd-image.sh
+++ /dev/null
@@ -1,154 +0,0 @@
-#!/usr/bin/env bash
-
-# Copyright 2024 Canonical Ltd.
-# See LICENSE file for licensing details.
-
-set -e
-
-retry() {
- local command="$1"
- local wait_message="$2"
- local max_try="$3"
-
- local attempt=0
-
- while ! $command
- do
- attempt=$((attempt + 1))
- if [[ attempt -ge $max_try ]]; then
- return
- fi
-
- echo "$wait_message"
- sleep 10
- done
-}
-
-cleanup() {
- local test_command="$1"
- local clean_up_command="$2"
- local wait_message="$3"
- local max_try="$4"
-
- local attempt=0
-
- while bash -c "$test_command"
- do
- echo "$wait_message"
-
- $clean_up_command
-
- attempt=$((attempt + 1))
- if [[ attempt -ge $max_try ]]; then
- # Cleanup failure.
- return 1
- fi
-
- sleep 10
- done
-}
-
-HTTP_PROXY="$1"
-HTTPS_PROXY="$2"
-NO_PROXY="$3"
-BASE_IMAGE="$4"
-MODE="$5"
-
-if [[ -n "$HTTP_PROXY" ]]; then
- /snap/bin/lxc config set core.proxy_http "$HTTP_PROXY"
-fi
-if [[ -n "$HTTPS_PROXY" ]]; then
- /snap/bin/lxc config set core.proxy_https "$HTTPS_PROXY"
-fi
-
-cleanup '/snap/bin/lxc info builder &> /dev/null' '/snap/bin/lxc delete builder --force' 'Cleanup LXD VM of previous run' 10
-
-if [[ "$MODE" == "test" ]]; then
- retry "/snap/bin/lxc launch ubuntu-daily:$BASE_IMAGE builder --device root,size=5GiB" 'Starting LXD container'
-else
- retry "/snap/bin/lxc launch ubuntu-daily:$BASE_IMAGE builder --vm --device root,size=8GiB" 'Starting LXD VM'
-fi
-retry '/snap/bin/lxc exec builder -- /usr/bin/who' 'Wait for lxd agent to be ready' 30
-if [[ -n "$HTTP_PROXY" ]]; then
- /snap/bin/lxc exec builder -- echo "HTTP_PROXY=$HTTP_PROXY" >> /etc/environment
- /snap/bin/lxc exec builder -- echo "http_proxy=$HTTP_PROXY" >> /etc/environment
- /snap/bin/lxc exec builder -- echo "Acquire::http::Proxy \"$HTTP_PROXY\";" >> /etc/apt/apt.conf
-fi
-if [[ -n "$HTTPS_PROXY" ]]; then
- /snap/bin/lxc exec builder -- echo "HTTPS_PROXY=$HTTPS_PROXY" >> /etc/environment
- /snap/bin/lxc exec builder -- echo "https_proxy=$HTTPS_PROXY" >> /etc/environment
- /snap/bin/lxc exec builder -- echo "Acquire::https::Proxy \"$HTTPS_PROXY\";" >> /etc/apt/apt.conf
-fi
-if [[ -n "$NO_PROXY" ]]; then
- /snap/bin/lxc exec builder -- echo "NO_PROXY=$NO_PROXY" >> /etc/environment
- /snap/bin/lxc exec builder -- echo "no_proxy=$NO_PROXY" >> /etc/environment
-fi
-retry '/snap/bin/lxc exec builder -- /usr/bin/nslookup github.com' 'Wait for network to be ready' 30
-
-/snap/bin/lxc exec builder -- /usr/bin/apt-get update
-/snap/bin/lxc exec builder --env DEBIAN_FRONTEND=noninteractive -- /usr/bin/apt-get upgrade -yq
-# This will remove older version of kernel as HWE is installed now.
-/snap/bin/lxc exec builder -- /usr/bin/apt-get autoremove --purge
-
-/snap/bin/lxc restart builder
-retry '/snap/bin/lxc exec builder -- /usr/bin/who' 'Wait for lxd agent to be ready' 30
-retry '/snap/bin/lxc exec builder -- /usr/bin/nslookup github.com' 'Wait for network to be ready' 30
-
-/snap/bin/lxc exec builder -- /usr/bin/apt-get update
-/snap/bin/lxc exec builder --env DEBIAN_FRONTEND=noninteractive -- /usr/bin/apt-get upgrade -yq
-/snap/bin/lxc exec builder --env DEBIAN_FRONTEND=noninteractive -- /usr/bin/apt-get install docker.io npm python3-pip shellcheck jq wget unzip gh -yq
-
-# Uninstall unattended-upgrades, to avoid lock errors when unattended-upgrades is active in the runner
-/snap/bin/lxc exec builder --env DEBIAN_FRONTEND=noninteractive -- /usr/bin/systemctl stop apt-daily.timer
-/snap/bin/lxc exec builder --env DEBIAN_FRONTEND=noninteractive -- /usr/bin/systemctl disable apt-daily.timer
-/snap/bin/lxc exec builder --env DEBIAN_FRONTEND=noninteractive -- /usr/bin/systemctl mask apt-daily.service
-/snap/bin/lxc exec builder --env DEBIAN_FRONTEND=noninteractive -- /usr/bin/systemctl stop apt-daily-upgrade.timer
-/snap/bin/lxc exec builder --env DEBIAN_FRONTEND=noninteractive -- /usr/bin/systemctl disable apt-daily-upgrade.timer
-/snap/bin/lxc exec builder --env DEBIAN_FRONTEND=noninteractive -- /usr/bin/systemctl mask apt-daily-upgrade.service
-/snap/bin/lxc exec builder --env DEBIAN_FRONTEND=noninteractive -- /usr/bin/systemctl daemon-reload
-/snap/bin/lxc exec builder --env DEBIAN_FRONTEND=noninteractive -- /usr/bin/apt-get purge unattended-upgrades -yq
-
-if [[ -n "$HTTP_PROXY" ]]; then
- /snap/bin/lxc exec builder -- /usr/bin/npm config set proxy "$HTTP_PROXY"
-fi
-if [[ -n "$HTTPS_PROXY" ]]; then
- /snap/bin/lxc exec builder -- /usr/bin/npm config set https-proxy "$HTTPS_PROXY"
-fi
-/snap/bin/lxc exec builder -- /usr/bin/npm install --global yarn
-/snap/bin/lxc exec builder -- /usr/sbin/groupadd microk8s
-/snap/bin/lxc exec builder -- /usr/sbin/usermod -aG microk8s ubuntu
-/snap/bin/lxc exec builder -- /usr/sbin/usermod -aG docker ubuntu
-/snap/bin/lxc exec builder -- /usr/sbin/iptables -I DOCKER-USER -j ACCEPT
-
-# Reduce image size
-/snap/bin/lxc exec builder -- /usr/bin/npm cache clean --force
-/snap/bin/lxc exec builder -- /usr/bin/apt-get clean
-
-# Download and verify checksum of yq
-if [[ $(uname -m) == 'aarch64' ]]; then
- YQ_ARCH="arm64"
-elif [[ $(uname -m) == 'arm64' ]]; then
- YQ_ARCH="arm64"
-elif [[ $(uname -m) == 'x86_64' ]]; then
- YQ_ARCH="amd64"
-else
- echo "Unsupported CPU architecture: $(uname -m)"
- return 1
-fi
-/usr/bin/wget "https://github.com/mikefarah/yq/releases/latest/download/yq_linux_$YQ_ARCH" -O "yq_linux_$YQ_ARCH"
-/usr/bin/wget https://github.com/mikefarah/yq/releases/latest/download/checksums -O checksums
-/usr/bin/wget https://github.com/mikefarah/yq/releases/latest/download/checksums_hashes_order -O checksums_hashes_order
-/usr/bin/wget https://github.com/mikefarah/yq/releases/latest/download/extract-checksum.sh -O extract-checksum.sh
-/usr/bin/bash extract-checksum.sh SHA-256 "yq_linux_$YQ_ARCH" | /usr/bin/awk '{print $2,$1}' | /usr/bin/sha256sum -c | /usr/bin/grep OK
-/snap/bin/lxc file push "yq_linux_$YQ_ARCH" builder/usr/bin/yq --mode 755
-
-/snap/bin/lxc exec builder -- /usr/bin/sync
-/snap/bin/lxc publish builder --alias builder --reuse -f
-
-# Swap in the built image
-/snap/bin/lxc image alias rename "$BASE_IMAGE" "old-$BASE_IMAGE" || true
-/snap/bin/lxc image alias rename builder "$BASE_IMAGE"
-/snap/bin/lxc image delete "old-$BASE_IMAGE" || true
-
-# Clean up LXD instance
-cleanup '/snap/bin/lxc info builder &> /dev/null' '/snap/bin/lxc delete builder --force' 'Cleanup LXD instance' 10
diff --git a/scripts/build-openstack-image.sh b/scripts/build-openstack-image.sh
deleted file mode 100755
index 76362d46f..000000000
--- a/scripts/build-openstack-image.sh
+++ /dev/null
@@ -1,186 +0,0 @@
-#!/usr/bin/env bash
-
-# Copyright 2024 Canonical Ltd.
-# See LICENSE file for licensing details.
-
-set -euo pipefail
-
-# GitHub runner bin args
-RUNNER_TAR_URL="$1"
-
-# Proxy args
-HTTP_PROXY="$2"
-HTTPS_PROXY="$3"
-NO_PROXY="$4"
-BASE_IMAGE="$7"
-
-# retry function
-retry() {
- local command="$1"
- local wait_message="$2"
- local max_try="$3"
-
- local attempt=0
-
- while ! $command
- do
- attempt=$((attempt + 1))
- if [[ attempt -ge $max_try ]]; then
- return
- fi
-
- echo "$wait_message"
- sleep 10
- done
-}
-
-# cleanup any existing mounts
-cleanup() {
- sudo umount /mnt/ubuntu-image/dev/ || true
- sudo umount /mnt/ubuntu-image/proc/ || true
- sudo umount /mnt/ubuntu-image/sys/ || true
- sudo umount /mnt/ubuntu-image || true
- sudo qemu-nbd --disconnect /dev/nbd0
-}
-
-# Check if proxy variables set, doesn't exist or is a different value then update.
-if [[ -n "$HTTP_PROXY" ]]; then
- if ! grep -q "HTTP_PROXY=" /etc/environment || ! grep -q "HTTP_PROXY=$HTTP_PROXY" /etc/environment; then
- sed -i "/^HTTP_PROXY=/d" /etc/environment
- echo "HTTP_PROXY=$HTTP_PROXY" >> /etc/environment
- fi
- if ! grep -q "http_proxy=" /etc/environment || ! grep -q "http_proxy=$HTTP_PROXY" /etc/environment; then
- sed -i "/^http_proxy=/d" /etc/environment
- echo "http_proxy=$HTTP_PROXY" >> /etc/environment
- fi
-fi
-
-if [[ -n "$HTTPS_PROXY" ]]; then
- if ! grep -q "HTTPS_PROXY=" /etc/environment || ! grep -q "HTTPS_PROXY=$HTTPS_PROXY" /etc/environment; then
- sed -i "/^HTTPS_PROXY=/d" /etc/environment
- echo "HTTPS_PROXY=$HTTPS_PROXY" >> /etc/environment
- fi
- if ! grep -q "https_proxy=" /etc/environment || ! grep -q "https_proxy=$HTTPS_PROXY" /etc/environment; then
- sed -i "/^https_proxy=/d" /etc/environment
- echo "https_proxy=$HTTPS_PROXY" >> /etc/environment
- fi
-fi
-
-if [[ -n "$NO_PROXY" ]]; then
- if ! grep -q "NO_PROXY=" /etc/environment || ! grep -q "NO_PROXY=$NO_PROXY" /etc/environment; then
- sed -i "/^NO_PROXY=/d" /etc/environment
- echo "NO_PROXY=$NO_PROXY" >> /etc/environment
- fi
- if ! grep -q "no_proxy=" /etc/environment || ! grep -q "no_proxy=$NO_PROXY" /etc/environment; then
- sed -i "/^no_proxy=/d" /etc/environment
- echo "no_proxy=$NO_PROXY" >> /etc/environment
- fi
-fi
-
-# Architecture args
-ARCH=$(uname -m)
-if [[ $ARCH == 'aarch64' ]]; then
- BIN_ARCH="arm64"
-elif [[ $ARCH == 'arm64' ]]; then
- BIN_ARCH="arm64"
-elif [[ $ARCH == 'x86_64' ]]; then
- BIN_ARCH="amd64"
-else
- echo "Unsupported CPU architecture: $ARCH"
- return 1
-fi
-
-# qemu-utils required to unpack qcow image
-sudo DEBIAN_FRONTEND=noninteractive apt-get install qemu-utils libguestfs-tools -y
-
-# enable network block device
-sudo modprobe nbd
-
-# cleanup any existing mounts
-cleanup
-
-retry "sudo wget https://cloud-images.ubuntu.com/$BASE_IMAGE/current/$BASE_IMAGE-server-cloudimg-$BIN_ARCH.img \
- -O $BASE_IMAGE-server-cloudimg-$BIN_ARCH.img" "Downloading cloud image" 3
-
-# resize image - installing dependencies requires more disk space
-sudo qemu-img resize "$BASE_IMAGE-server-cloudimg-$BIN_ARCH.img" +1.5G
-
-# mount nbd
-echo "Connecting network block device to image"
-sudo qemu-nbd --connect=/dev/nbd0 "$BASE_IMAGE-server-cloudimg-$BIN_ARCH.img"
-sudo mkdir -p /mnt/ubuntu-image
-retry "sudo mount -o rw /dev/nbd0p1 /mnt/ubuntu-image" "Mounting nbd0p1 device" 3
-
-# mount required system dirs
-echo "Mounting sys dirs"
-retry "sudo mount --bind /dev/ /mnt/ubuntu-image/dev/" "Mounting /dev/" 3
-retry "sudo mount --bind /proc/ /mnt/ubuntu-image/proc/" "Mounting /proc/" 3
-retry "sudo mount --bind /sys/ /mnt/ubuntu-image/sys/" "Mounting /sys/" 3
-sudo rm /mnt/ubuntu-image/etc/resolv.conf -f
-sudo cp /etc/resolv.conf /mnt/ubuntu-image/etc/resolv.conf
-
-# resize mount
-echo "Resizing mounts"
-sudo growpart /dev/nbd0 1 # grow partition size to available space
-sudo resize2fs /dev/nbd0p1 # resize fs accordingly
-
-# chroot and install dependencies
-echo "Installing dependencies in chroot env"
-sudo chroot /mnt/ubuntu-image/ <
+
## function `catch_charm_errors`
@@ -54,7 +52,7 @@ Catch common errors in charm.
---
-
+
## function `catch_action_errors`
@@ -83,19 +81,7 @@ Catch common errors in actions.
## class `GithubRunnerCharm`
Charm for managing GitHub self-hosted runners.
-
-
-**Attributes:**
-
- - `service_token_path`: The path to token to access local services.
- - `repo_check_web_service_path`: The path to repo-policy-compliance service directory.
- - `repo_check_web_service_script`: The path to repo-policy-compliance web service script.
- - `repo_check_systemd_service`: The path to repo-policy-compliance unit file.
- - `juju_storage_path`: The path to juju storage.
- - `ram_pool_path`: The path to memdisk storage.
- - `kernel_module_path`: The path to kernel modules.
-
-
+
### function `__init__`
@@ -113,12 +99,6 @@ Construct the charm.
- `kwargs`: List of keyword arguments to be passed to the `CharmBase` class.
-
-**Raises:**
-
- - `RuntimeError`: If invalid test configuration was detected.
-
-
---
#### property app
diff --git a/src-docs/charm_state.py.md b/src-docs/charm_state.py.md
index 64ff18954..68b1df9b8 100644
--- a/src-docs/charm_state.py.md
+++ b/src-docs/charm_state.py.md
@@ -7,11 +7,8 @@ State of the Charm.
**Global Variables**
---------------
-- **REACTIVE_MODE_NOT_SUPPORTED_WITH_LXD_ERR_MSG**
- **ARCHITECTURES_ARM64**
- **ARCHITECTURES_X86**
-- **BASE_IMAGE_CONFIG_NAME**
-- **DENYLIST_CONFIG_NAME**
- **DOCKERHUB_MIRROR_CONFIG_NAME**
- **GROUP_CONFIG_NAME**
- **LABELS_CONFIG_NAME**
@@ -22,20 +19,15 @@ State of the Charm.
- **RECONCILE_INTERVAL_CONFIG_NAME**
- **REPO_POLICY_COMPLIANCE_TOKEN_CONFIG_NAME**
- **REPO_POLICY_COMPLIANCE_URL_CONFIG_NAME**
-- **RUNNER_STORAGE_CONFIG_NAME**
- **SENSITIVE_PLACEHOLDER**
- **TEST_MODE_CONFIG_NAME**
- **TOKEN_CONFIG_NAME**
- **USE_APROXY_CONFIG_NAME**
- **VIRTUAL_MACHINES_CONFIG_NAME**
-- **VM_CPU_CONFIG_NAME**
-- **VM_MEMORY_CONFIG_NAME**
-- **VM_DISK_CONFIG_NAME**
- **COS_AGENT_INTEGRATION_NAME**
- **DEBUG_SSH_INTEGRATION_NAME**
- **IMAGE_INTEGRATION_NAME**
- **MONGO_DB_INTEGRATION_NAME**
-- **LTS_IMAGE_VERSION_TAG_MAP**
---
@@ -69,22 +61,6 @@ Supported system architectures.
----
-
-## class `BaseImage`
-The ubuntu OS base image to build and deploy runners on.
-
-
-
-**Attributes:**
-
- - `JAMMY`: The jammy ubuntu LTS image.
- - `NOBLE`: The noble ubuntu LTS image.
-
-
-
-
-
---
## class `CharmConfig`
@@ -96,7 +72,6 @@ Some charm configurations are grouped into other configuration models.
**Attributes:**
- - `denylist`: List of IPv4 to block the runners from accessing.
- `dockerhub_mirror`: Private docker registry as dockerhub mirror for the runners to use.
- `labels`: Additional runner labels to append to default (i.e. os, flavor, architecture).
- `openstack_clouds_yaml`: The openstack clouds.yaml configuration.
@@ -110,7 +85,7 @@ Some charm configurations are grouped into other configuration models.
---
-
+
### classmethod `check_reconcile_interval`
@@ -139,7 +114,7 @@ Validate the general charm configuration.
---
-
+
### classmethod `from_charm`
@@ -178,7 +153,7 @@ Raised when charm config is invalid.
- `msg`: Explanation of the error.
-
+
### function `__init__`
@@ -211,7 +186,6 @@ The charm state.
- `charm_config`: Configuration of the juju charm.
- `is_metrics_logging_available`: Whether the charm is able to issue metrics.
- `proxy_config`: Proxy-related configuration.
- - `instance_type`: The type of instances, e.g., local lxd, openstack.
- `reactive_config`: The charm configuration related to reactive spawning mode.
- `runner_config`: The charm configuration related to runner VM configuration.
- `ssh_debug_connections`: SSH debug connections configuration information.
@@ -221,7 +195,7 @@ The charm state.
---
-
+
### classmethod `from_charm`
@@ -267,7 +241,7 @@ Charm configuration related to GitHub.
---
-
+
### classmethod `from_charm`
@@ -295,154 +269,6 @@ Get github related charm configuration values from charm.
The parsed GitHub configuration values.
----
-
-## class `ImmutableConfigChangedError`
-Represents an error when changing immutable charm state.
-
-
-
-### function `__init__`
-
-```python
-__init__(msg: str)
-```
-
-Initialize a new instance of the ImmutableConfigChangedError exception.
-
-
-
-**Args:**
-
- - `msg`: Explanation of the error.
-
-
-
-
-
----
-
-## class `InstanceType`
-Type of instance for runner.
-
-
-
-**Attributes:**
-
- - `LOCAL_LXD`: LXD instance on the local juju machine.
- - `OPENSTACK`: OpenStack instance on a cloud.
-
-
-
-
-
----
-
-## class `LocalLxdRunnerConfig`
-Runner configurations for local LXD instances.
-
-
-
-**Attributes:**
-
- - `base_image`: The ubuntu base image to run the runner virtual machines on.
- - `virtual_machines`: Number of virtual machine-based runner to spawn.
- - `virtual_machine_resources`: Hardware resource used by one virtual machine for a runner.
- - `runner_storage`: Storage to be used as disk for the runner.
-
-
-
-
----
-
-
-
-### classmethod `check_virtual_machine_resources`
-
-```python
-check_virtual_machine_resources(
- vm_resources: VirtualMachineResources
-) → VirtualMachineResources
-```
-
-Validate the virtual_machine_resources field values.
-
-
-
-**Args:**
-
- - `vm_resources`: the virtual_machine_resources value to validate.
-
-
-
-**Raises:**
-
- - `ValueError`: if an invalid number of cpu was given or invalid memory/disk size was given.
-
-
-
-**Returns:**
- The validated virtual_machine_resources value.
-
----
-
-
-
-### classmethod `check_virtual_machines`
-
-```python
-check_virtual_machines(virtual_machines: int) → int
-```
-
-Validate the virtual machines configuration value.
-
-
-
-**Args:**
-
- - `virtual_machines`: The virtual machines value to validate.
-
-
-
-**Raises:**
-
- - `ValueError`: if a negative integer was passed.
-
-
-
-**Returns:**
- Validated virtual_machines value.
-
----
-
-
-
-### classmethod `from_charm`
-
-```python
-from_charm(charm: CharmBase) → LocalLxdRunnerConfig
-```
-
-Initialize the config from charm.
-
-
-
-**Args:**
-
- - `charm`: The charm instance.
-
-
-
-**Raises:**
-
- - `CharmConfigInvalidError`: if an invalid runner charm config has been set on the charm.
-
-
-
-**Returns:**
- Local LXD runner config of the charm.
-
-
---
## class `OpenStackCloudsYAML`
@@ -475,7 +301,7 @@ OpenstackImage from image builder relation data.
---
-
+
### classmethod `from_charm`
@@ -518,7 +344,7 @@ Runner configuration for OpenStack Instances.
---
-
+
### classmethod `from_charm`
@@ -572,7 +398,7 @@ Return the aproxy address.
---
-
+
### classmethod `check_use_aproxy`
@@ -602,7 +428,7 @@ Validate the proxy configuration.
---
-
+
### classmethod `from_charm`
@@ -640,7 +466,7 @@ Represents the configuration for reactive scheduling.
---
-
+
### classmethod `from_database`
@@ -685,7 +511,7 @@ Configuration for the repo policy compliance service.
---
-
+
### classmethod `from_charm`
@@ -715,20 +541,51 @@ Initialize the config from charm.
---
-## class `RunnerStorage`
-Supported storage as runner disk.
+## class `OpenstackRunnerConfig`
+Runner configuration for OpenStack Instances.
**Attributes:**
- - `JUJU_STORAGE`: Represents runner storage from Juju storage.
- - `MEMORY`: Represents tempfs storage (ramdisk).
+ - `virtual_machines`: Number of virtual machine-based runner to spawn.
+ - `openstack_flavor`: flavor on openstack to use for virtual machines.
+ - `openstack_network`: Network on openstack to use for virtual machines.
+ - `openstack_image`: Openstack image to use for virtual machines.
+
+
+
+
+---
+
+
+
+### classmethod `from_charm`
+
+```python
+from_charm(charm: CharmBase) → OpenstackRunnerConfig
+```
+
+Initialize the config from charm.
+
+
+
+**Args:**
+
+ - `charm`: The charm instance.
+
+**Raises:**
+
+ - `CharmConfigInvalidError`: Error with charm configuration virtual-machines not of int type.
+**Returns:**
+ Openstack runner config of the charm.
+
+
---
## class `SSHDebugConnection`
@@ -748,7 +605,7 @@ SSH connection information for debug workflow.
---
-
+
### classmethod `from_charm`
@@ -781,7 +638,7 @@ Raised when given machine charm architecture is unsupported.
- `arch`: The current machine architecture.
-
+
### function `__init__`
@@ -801,20 +658,3 @@ Initialize a new instance of the CharmConfigInvalidError exception.
----
-
-## class `VirtualMachineResources`
-Virtual machine resource configuration.
-
-
-
-**Attributes:**
-
- - `cpu`: Number of vCPU for the virtual machine.
- - `memory`: Amount of memory for the virtual machine.
- - `disk`: Amount of disk for the virtual machine.
-
-
-
-
-
diff --git a/src-docs/errors.py.md b/src-docs/errors.py.md
index f976fcf0a..46a8560e9 100644
--- a/src-docs/errors.py.md
+++ b/src-docs/errors.py.md
@@ -16,15 +16,6 @@ Error for juju configuration.
----
-
-## class `IssueMetricEventError`
-Represents an error when issuing a metric event.
-
-
-
-
-
---
## class `LogrotateSetupError`
@@ -34,15 +25,6 @@ Represents an error raised when logrotate cannot be setup.
----
-
-## class `LxdError`
-Error for executing LXD actions.
-
-
-
-
-
---
## class `MissingMongoDBError`
@@ -52,96 +34,6 @@ Error for missing integration data.
----
-
-## class `MissingRunnerBinaryError`
-Error for missing runner binary.
-
-
-
-
-
----
-
-## class `MissingServerConfigError`
-Error for unable to create runner due to missing server configurations.
-
-
-
-
-
----
-
-## class `RunnerAproxyError`
-Error for setting up aproxy.
-
-
-
-
-
----
-
-## class `RunnerBinaryError`
-Error of getting runner binary.
-
-
-
-
-
----
-
-## class `RunnerCreateError`
-Error for runner creation failure.
-
-
-
-
-
----
-
-## class `RunnerFileLoadError`
-Error for loading file on runner.
-
-
-
-
-
----
-
-## class `RunnerLogsError`
-Base class for all runner logs errors.
-
-
-
-
-
----
-
-## class `RunnerRemoveError`
-Error for runner removal failure.
-
-
-
-
-
----
-
-## class `SharedFilesystemError`
-Base class for all shared filesystem errors.
-
-
-
-
-
----
-
-## class `SharedFilesystemMountError`
-Represents an error related to the mounting of the shared filesystem.
-
-
-
-
-
---
## class `SubprocessError`
@@ -156,7 +48,7 @@ Error for Subprocess calls.
- `stdout`: Content of stdout of the subprocess.
- `stderr`: Content of stderr of the subprocess.
-
+
### function `__init__`
diff --git a/src-docs/firewall.py.md b/src-docs/firewall.py.md
deleted file mode 100644
index 486c03290..000000000
--- a/src-docs/firewall.py.md
+++ /dev/null
@@ -1,118 +0,0 @@
-
-
-
-
-# module `firewall.py`
-The runner firewall manager.
-
-
-
----
-
-## class `Firewall`
-Represent a firewall and provides methods to refresh its configuration.
-
-
-
-### function `__init__`
-
-```python
-__init__(network: str)
-```
-
-Initialize a new Firewall instance.
-
-
-
-**Args:**
-
- - `network`: The LXD network name.
-
-
-
-
----
-
-
-
-### function `get_host_ip`
-
-```python
-get_host_ip() → str
-```
-
-Get the host IP address for the corresponding LXD network.
-
-
-
-**Returns:**
- The host IP address.
-
----
-
-
-
-### function `refresh_firewall`
-
-```python
-refresh_firewall(
- denylist: Iterable[FirewallEntry],
- allowlist: Optional[Iterable[FirewallEntry]] = None
-) → None
-```
-
-Refresh the firewall configuration.
-
-
-
-**Args:**
-
- - `denylist`: The list of FirewallEntry rules to allow.
- - `allowlist`: The list of FirewallEntry rules to allow.
-
-
----
-
-## class `FirewallEntry`
-Represent an entry in the firewall.
-
-
-
-**Attributes:**
-
- - `ip_range`: The IP address range using CIDR notation.
-
-
-
-
----
-
-
-
-### classmethod `decode`
-
-```python
-decode(entry: str) → FirewallEntry
-```
-
-Decode a firewall entry from a string.
-
-
-
-**Args:**
-
- - `entry`: The firewall entry string, e.g. '192.168.0.1:80' or '192.168.0.0/24:80-90:udp'.
-
-
-
-**Returns:**
-
- - `FirewallEntry`: A FirewallEntry instance representing the decoded entry.
-
-
-
-**Raises:**
-
- - `ValueError`: If the entry string is not in the expected format.
-
-
diff --git a/src-docs/github_client.py.md b/src-docs/github_client.py.md
deleted file mode 100644
index 795b92d10..000000000
--- a/src-docs/github_client.py.md
+++ /dev/null
@@ -1,55 +0,0 @@
-
-
-
-
-# module `github_client.py`
-GitHub API client.
-
-Migrate to PyGithub in the future. PyGithub is still lacking some API such as remove token for runner.
-
-
-
----
-
-## class `GithubClient`
-GitHub API client.
-
-
-
-
----
-
-
-
-### function `get_runner_application`
-
-```python
-get_runner_application(
- path: GitHubOrg | GitHubRepo,
- arch: Arch,
- os: str = 'linux'
-) → RunnerApplication
-```
-
-Get runner application available for download for given arch.
-
-
-
-**Args:**
-
- - `path`: GitHub repository path in the format '
-
-# module `lxd.py`
-Low-level LXD client interface.
-
-The LxdClient class offers a low-level interface to isolate the underlying implementation of LXD.
-
-**Global Variables**
----------------
-- **LXC_BINARY**
-
-
----
-
-## class `LxdClient`
-LXD client.
-
-
-
-### function `__init__`
-
-```python
-__init__() → None
-```
-
-Instantiate the LXD client.
-
-
-
-
-
----
-
-## class `LxdImageManager`
-LXD image manager.
-
-
-
-### function `__init__`
-
-```python
-__init__(pylxd_client: 'Client')
-```
-
-Instantiate the LXD image manager.
-
-
-
-**Args:**
-
- - `pylxd_client`: Instance of pylxd.Client.
-
-
-
-
----
-
-
-
-### function `create`
-
-```python
-create(name: 'str', path: 'Path') → None
-```
-
-Import a LXD image.
-
-
-
-**Args:**
-
- - `name`: Alias for the image.
- - `path`: Path of the LXD image file.
-
-
-
-**Raises:**
-
- - `LxdError`: Unable to import the file as LXD image.
-
----
-
-
-
-### function `exists`
-
-```python
-exists(alias: 'str') → bool
-```
-
-Check if an image with the given name exists.
-
-
-
-**Args:**
-
- - `alias`: Alias name of the image to check.
-
-
-
-**Returns:**
- Whether the image exists.
-
-
----
-
-## class `LxdInstance`
-An LXD instance.
-
-
-
-**Attributes:**
-
- - `name` (str): Name of the LXD instance.
- - `files` (LxdInstanceFiles): Manager for the files on the LXD instance.
- - `status` (str): Status of the LXD instance.
-
-
-
-### function `__init__`
-
-```python
-__init__(pylxd_instance: 'Instance')
-```
-
-Instantiate the LXD instance representation.
-
-
-
-**Args:**
-
- - `pylxd_instance`: Instance of pylxd.models.Instance for the LXD instance.
-
-
----
-
-#### property status
-
-Status of the LXD instance.
-
-
-
-**Returns:**
- Status of the LXD instance.
-
-
-
----
-
-
-
-### function `delete`
-
-```python
-delete(wait: 'bool' = False) → None
-```
-
-Delete the LXD instance.
-
-
-
-**Args:**
-
- - `wait`: Whether to wait until the LXD instance is stopped before returning.
-
-
-
-**Raises:**
-
- - `LxdError`: Unable to delete the LXD instance.
-
----
-
-
-
-### function `execute`
-
-```python
-execute(
- cmd: 'list[str]',
- cwd: 'Optional[str]' = None,
- hide_cmd: 'bool' = False,
- **kwargs: 'Any'
-) → Tuple[int, IO, IO]
-```
-
-Execute a command within the LXD instance.
-
-Exceptions are not raised if command execution failed. Caller should check the exit code and stderr for errors.
-
-The command is executed with `subprocess.run`, additional arguments can be passed to it as keyword arguments. The following arguments to `subprocess.run` should not be set: `capture_output`, `shell`, `check`. As those arguments are used by this function.
-
-
-
-**Args:**
-
- - `cmd`: Commands to be executed.
- - `cwd`: Working directory to execute the commands.
- - `hide_cmd`: Hide logging of cmd.
- - `kwargs`: Additional keyword arguments for the `subprocess.run` call.
-
-
-
-
-
-**Returns:**
- Tuple containing the exit code, stdout, stderr.
-
----
-
-
-
-### function `start`
-
-```python
-start(timeout: 'int' = 30, force: 'bool' = True, wait: 'bool' = False) → None
-```
-
-Start the LXD instance.
-
-
-
-**Args:**
-
- - `timeout`: Timeout for starting the LXD instance.
- - `force`: Whether to force start the LXD instance.
- - `wait`: Whether to wait until the LXD instance is started before returning.
-
-
-
-**Raises:**
-
- - `LxdError`: Unable to start the LXD instance.
-
----
-
-
-
-### function `stop`
-
-```python
-stop(timeout: 'int' = 30, force: 'bool' = True, wait: 'bool' = False) → None
-```
-
-Stop the LXD instance.
-
-
-
-**Args:**
-
- - `timeout`: Timeout for stopping the LXD instance.
- - `force`: Whether to force stop the LXD instance.
- - `wait`: Whether to wait until the LXD instance is stopped before returning.
-
-
-
-**Raises:**
-
- - `LxdError`: Unable to stop the LXD instance.
-
-
----
-
-## class `LxdInstanceFileManager`
-File manager of an LXD instance.
-
-
-
-**Attributes:**
-
- - `instance` (LxdInstance): LXD instance where the files are located in.
-
-
-
-### function `__init__`
-
-```python
-__init__(instance: 'LxdInstance')
-```
-
-Instantiate the file manager.
-
-
-
-**Args:**
-
- - `instance`: LXD instance where the files are located in.
-
-
-
-
----
-
-
-
-### function `mk_dir`
-
-```python
-mk_dir(dir_name: 'str') → None
-```
-
-Create a directory in the LXD instance.
-
-
-
-**Args:**
-
- - `dir_name`: Name of the directory to create.
-
----
-
-
-
-### function `pull_file`
-
-```python
-pull_file(source: 'str', destination: 'str', is_dir: 'bool' = False) → None
-```
-
-Pull a file from the LXD instance to the local machine.
-
-
-
-**Args:**
-
- - `source`: Path of the file to pull in the LXD instance.
- - `destination`: Path in local machine.
- - `is_dir`: Whether the source is a directory.
-
-
-
-**Raises:**
-
- - `LxdError`: Unable to load the file from the LXD instance.
-
----
-
-
-
-### function `push_file`
-
-```python
-push_file(
- source: 'str',
- destination: 'str',
- mode: 'Optional[str]' = None
-) → None
-```
-
-Push a file to the LXD instance.
-
-
-
-**Args:**
-
- - `source`: Path of the file to push to the LXD instance.
- - `destination`: Path in the LXD instance to load the file.
- - `mode`: File permissions.
-
-
-
-**Raises:**
-
- - `LxdError`: Unable to load the file into the LXD instance.
-
----
-
-
-
-### function `read_file`
-
-```python
-read_file(filepath: 'str') → str
-```
-
-Read the content of a file in the LXD instance.
-
-
-
-**Args:**
-
- - `filepath`: Path of the file in the LXD instance.
-
-
-
-**Raises:**
-
- - `LxdError`: Unable to load the file from the LXD instance.
-
-
-
-**Returns:**
- The content of the file.
-
----
-
-
-
-### function `write_file`
-
-```python
-write_file(
- filepath: 'str',
- content: 'Union[str, bytes]',
- mode: 'Optional[str]' = None
-) → None
-```
-
-Write a file with the given content into the LXD instance.
-
-
-
-**Args:**
-
- - `filepath`: Path in the LXD instance to load the file.
- - `content`: Content of the file.
- - `mode`: File permission setting.
-
-
-
-**Raises:**
-
- - `LxdError`: Unable to load the file to the LXD instance.
-
-
----
-
-## class `LxdInstanceManager`
-LXD instance manager.
-
-
-
-### function `__init__`
-
-```python
-__init__(pylxd_client: 'Client')
-```
-
-Instantiate the LXD instance manager.
-
-
-
-**Args:**
-
- - `pylxd_client`: Instance of pylxd.Client.
-
-
-
-
----
-
-
-
-### function `all`
-
-```python
-all() → list[LxdInstance]
-```
-
-Get list of LXD instances.
-
-
-
-**Raises:**
-
- - `LxdError`: Unable to get all LXD instances.
-
-
-
-**Returns:**
- List of LXD instances.
-
----
-
-
-
-### function `create`
-
-```python
-create(config: 'LxdInstanceConfig', wait: 'bool') → LxdInstance
-```
-
-Create an LXD instance.
-
-
-
-**Args:**
-
- - `config`: Configuration for the LXD instance.
- - `wait`: Whether to wait until the LXD instance is created before returning.
-
-
-
-**Raises:**
-
- - `LxdError`: Unable to get all LXD instances.
-
-
-
-**Returns:**
- The created LXD instance.
-
-
----
-
-## class `LxdNetworkManager`
-LXD network manager.
-
-
-
-### function `__init__`
-
-```python
-__init__(pylxd_client: 'Client')
-```
-
-Instantiate the LXD profile manager.
-
-
-
-**Args:**
-
- - `pylxd_client`: Instance of pylxd.Client.
-
-
-
-
----
-
-
-
-### function `get`
-
-```python
-get(name: 'str') → LxdNetwork
-```
-
-Get the LXD network information.
-
-
-
-**Args:**
-
- - `name`: The name of the LXD network.
-
-
-
-**Returns:**
- Information on the LXD network.
-
-
----
-
-## class `LxdProfile`
-LXD profile.
-
-
-
-### function `__init__`
-
-```python
-__init__(pylxd_profile: 'Profile')
-```
-
-Instantiate the LXD profile.
-
-
-
-**Args:**
-
- - `pylxd_profile`: Instance of the pylxd.models.Profile.
-
-
-
-
----
-
-
-
-### function `delete`
-
-```python
-delete() → None
-```
-
-Delete the profile.
-
----
-
-
-
-### function `save`
-
-```python
-save() → None
-```
-
-Save the current configuration of profile.
-
-
----
-
-## class `LxdProfileManager`
-LXD profile manager.
-
-
-
-### function `__init__`
-
-```python
-__init__(pylxd_client: 'Client')
-```
-
-Instantiate the LXD profile manager.
-
-
-
-**Args:**
-
- - `pylxd_client`: Instance of pylxd.Client.
-
-
-
-
----
-
-
-
-### function `create`
-
-```python
-create(
- name: 'str',
- config: 'LxdResourceProfileConfig',
- devices: 'LxdResourceProfileDevices'
-) → None
-```
-
-Create an LXD profile.
-
-
-
-**Args:**
-
- - `name`: Name of the LXD profile to create.
- - `config`: Configuration of the LXD profile.
- - `devices`: Devices configuration of the LXD profile.
-
-
-
-**Raises:**
-
- - `LxdError`: Unable to create the LXD profile.
-
----
-
-
-
-### function `exists`
-
-```python
-exists(name: 'str') → bool
-```
-
-Check whether an LXD profile of a given name exists.
-
-
-
-**Args:**
-
- - `name`: Name for LXD profile to check.
-
-
-
-**Raises:**
-
- - `LxdError`: Unable to check the LXD profile existence.
-
-
-
-**Returns:**
- Whether the LXD profile of the given name exists.
-
----
-
-
-
-### function `get`
-
-```python
-get(name: 'str') → LxdProfile
-```
-
-Get an LXD profile.
-
-
-
-**Args:**
-
- - `name`: Name of the LXD profile.
-
-
-
-**Raises:**
-
- - `LxdError`: Unable to get the LXD profile with the name.
-
-
-
-**Returns:**
- LXDProfile with given name.
-
-
----
-
-## class `LxdStoragePool`
-An LXD storage pool.
-
-
-
-**Attributes:**
-
- - `name` (str): Name of the storage pool.
- - `driver` (str): Type of driver of the storage pool.
- - `used_by` (list[str]): LXD instances using the storage pool.
- - `config` (dict[str, any]): Dictionary of the configuration of the storage pool.
- - `managed` (bool): Whether LXD manages the storage pool.
-
-
-
-### function `__init__`
-
-```python
-__init__(pylxd_storage_pool: 'StoragePool')
-```
-
-Instantiate the LXD storage pool.
-
-
-
-**Args:**
-
- - `pylxd_storage_pool`: Instance of the pylxd.models.StoragePool.
-
-
-
-
----
-
-
-
-### function `delete`
-
-```python
-delete() → None
-```
-
-Delete the storage pool.
-
----
-
-
-
-### function `save`
-
-```python
-save() → None
-```
-
-Save the current configuration of storage pool.
-
-
----
-
-## class `LxdStoragePoolManager`
-LXD storage pool manager.
-
-
-
-### function `__init__`
-
-```python
-__init__(pylxd_client: 'Client')
-```
-
-Instantiate the LXD storage pool manager.
-
-
-
-**Args:**
-
- - `pylxd_client`: Instance of pylxd.Client.
-
-
-
-
----
-
-
-
-### function `all`
-
-```python
-all() → list[LxdStoragePool]
-```
-
-Get all LXD storage pool.
-
-
-
-**Returns:**
- List of LXD storage pools.
-
----
-
-
-
-### function `create`
-
-```python
-create(config: 'LxdStoragePoolConfiguration') → LxdStoragePool
-```
-
-Create an LXD storage pool.
-
-
-
-**Args:**
-
- - `config`: Configuration for the storage pool.
-
-
-
-**Returns:**
- The LXD storage pool.
-
----
-
-
-
-### function `exists`
-
-```python
-exists(name: 'str') → bool
-```
-
-Check if an LXD storage pool exists.
-
-
-
-**Args:**
-
- - `name`: Name to check for.
-
-
-
-**Returns:**
- Whether the storage pool exists.
-
----
-
-
-
-### function `get`
-
-```python
-get(name: 'str') → LxdStoragePool
-```
-
-Get an LXD storage pool.
-
-
-
-**Args:**
-
- - `name`: Name of the storage pool.
-
-
-
-**Raises:**
-
- - `LxdError`: If the storage pool with given name was not found.
-
-
-
-**Returns:**
- The LXD storage pool.
-
-
diff --git a/src-docs/lxd_type.py.md b/src-docs/lxd_type.py.md
deleted file mode 100644
index 0b4ec54bb..000000000
--- a/src-docs/lxd_type.py.md
+++ /dev/null
@@ -1,134 +0,0 @@
-
-
-
-
-# module `lxd_type.py`
-Types used by Lxd class.
-
-The details of the configuration of different types of devices can be found here: https://linuxcontainers.org/lxd/docs/latest/reference/devices/
-
-For example, configuration for disk: https://linuxcontainers.org/lxd/docs/latest/reference/devices_disk/#
-
-The unit of storage and network limits can be found here: https://linuxcontainers.org/lxd/docs/latest/reference/instance_units/#instances-limit-units
-
-
-
----
-
-## class `LxdInstanceConfig`
-Configuration for the LXD instance.
-
-See https://documentation.ubuntu.com/lxd/en/latest/howto/instances_create/
-
-
-
-**Attributes:**
-
- - `name`: Name of the instance.
- - `type`: Instance type, i.e. "container" or "virtual-machine".
- - `source`: Instance creation source configuration.
- - `ephemeral`: Whether the container should be deleted after a single run.
- - `profiles`: List of LXD profiles applied to the instance.
-
-
-
-
-
----
-
-## class `LxdInstanceConfigSource`
-Configuration for source image in the LXD instance.
-
-
-
-**Attributes:**
-
- - `type`: Type of source configuration, e.g. image, disk
- - `server`: The source server URL, e.g. https://cloud-images.ubuntu.com/releases
- - `protocol`: Protocol of the configuration, e.g. simplestreams
- - `alias`: Alias for configuration.
-
-
-
-
-
----
-
-## class `LxdNetwork`
-LXD network information.
-
-
-
-**Attributes:**
-
- - `name`: The name of LXD network.
- - `description`: LXD network descriptor.
- - `type`: Network type, i.e. "bridge", "physical"
- - `config`: The LXD network configuration values.
- - `managed`: Whether the network is being managed by lxd.
- - `used_by`: Number of instances using the network.
-
-
-
-
-
----
-
-## class `LxdNetworkConfig`
-Represent LXD network configuration.
-
-
-
-
-
----
-
-## class `LxdResourceProfileConfig`
-Configuration LXD profile.
-
-
-
-
-
----
-
-## class `LxdResourceProfileDevicesDisk`
-LXD device profile of disk.
-
-
-
-
-
----
-
-## class `LxdStoragePoolConfig`
-Configuration of the storage pool.
-
-
-
-**Attributes:**
-
- - `source`: The storage pool configuration source image.
- - `size`: The size of the storage pool, e.g. 30GiB
-
-
-
-
-
----
-
-## class `LxdStoragePoolConfiguration`
-Configuration for LXD storage pool.
-
-
-
-**Attributes:**
-
- - `name`: The storage pool name.
- - `driver`: The storage driver being used, i.e. "dir", "btrfs", ... . See https://documentation.ubuntu.com/lxd/en/stable-5.0/reference/storage_drivers/ for more information.
- - `config`: The storage pool configuration.
-
-
-
-
-
diff --git a/src-docs/runner.py.md b/src-docs/runner.py.md
deleted file mode 100644
index 96e5102d2..000000000
--- a/src-docs/runner.py.md
+++ /dev/null
@@ -1,180 +0,0 @@
-
-
-
-
-# module `runner.py`
-Manage the lifecycle of runners.
-
-The `Runner` class stores the information on the runners and manages the lifecycle of the runners on LXD and GitHub.
-
-The `RunnerManager` class from `runner_manager.py` creates and manages a collection of `Runner` instances.
-
-**Global Variables**
----------------
-- **APROXY_ARM_REVISION**
-- **APROXY_AMD_REVISION**
-
-
----
-
-## class `CreateRunnerConfig`
-The configuration values for creating a single runner instance.
-
-
-
-**Attributes:**
-
- - `image`: Name of the image to launch the LXD instance with.
- - `resources`: Resource setting for the LXD instance.
- - `binary_path`: Path to the runner binary.
- - `registration_token`: Token for registering the runner on GitHub.
- - `arch`: Current machine architecture.
-
-
-
-
-
----
-
-## class `Runner`
-Single instance of GitHub self-hosted runner.
-
-
-
-**Attributes:**
-
- - `runner_application`: The runner application directory path
- - `env_file`: The runner environment source .env file path.
- - `config_script`: The runner configuration script file path.
- - `runner_script`: The runner start script file path.
- - `pre_job_script`: The runner pre_job script file path. This is referenced in the env_file in the ACTIONS_RUNNER_HOOK_JOB_STARTED environment variable.
-
-
-
-### function `__init__`
-
-```python
-__init__(
- clients: RunnerManagerClients,
- runner_config: RunnerConfig,
- runner_status: RunnerStatus,
- instance: Optional[LxdInstance] = None
-)
-```
-
-Construct the runner instance.
-
-
-
-**Args:**
-
- - `clients`: Clients to access various services.
- - `runner_config`: Configuration of the runner instance.
- - `runner_status`: Status info of the given runner.
- - `instance`: LXD instance of the runner if already created.
-
-
-
-
----
-
-
-
-### function `create`
-
-```python
-create(config: CreateRunnerConfig) → None
-```
-
-Create the runner instance on LXD and register it on GitHub.
-
-
-
-**Args:**
-
- - `config`: The instance config to create the LXD VMs and configure GitHub runner with.
-
-
-
-**Raises:**
-
- - `RunnerCreateError`: Unable to create an LXD instance for runner.
-
----
-
-
-
-### function `pull_logs`
-
-```python
-pull_logs() → None
-```
-
-Pull the logs of the runner into a directory.
-
-Expects the runner to have an instance.
-
-
-
-**Raises:**
-
- - `RunnerLogsError`: If the runner logs could not be pulled.
-
----
-
-
-
-### function `remove`
-
-```python
-remove(remove_token: Optional[str]) → None
-```
-
-Remove this runner instance from LXD and GitHub.
-
-
-
-**Args:**
-
- - `remove_token`: Token for removing the runner on GitHub.
-
-
-
-**Raises:**
-
- - `RunnerRemoveError`: Failure in removing runner.
-
-
----
-
-## class `Snap`
-This class represents a snap installation.
-
-
-
-**Attributes:**
-
- - `name`: The snap application name.
- - `channel`: The channel to install the snap from.
- - `revision`: The revision number of the snap installation.
-
-
-
-
-
----
-
-## class `WgetExecutable`
-The executable to be installed through wget.
-
-
-
-**Attributes:**
-
- - `url`: The URL of the executable binary.
- - `cmd`: Executable command name. E.g. yq_linux_amd64 -> yq
-
-
-
-
-
diff --git a/src-docs/runner_manager.py.md b/src-docs/runner_manager.py.md
deleted file mode 100644
index b1400ec1c..000000000
--- a/src-docs/runner_manager.py.md
+++ /dev/null
@@ -1,244 +0,0 @@
-
-
-
-
-# module `runner_manager.py`
-Runner Manager manages the runners on LXD and GitHub.
-
-**Global Variables**
----------------
-- **RUNNER_INSTALLED_TS_FILE_NAME**
-- **REMOVED_RUNNER_LOG_STR**
-
-
----
-
-## class `LXDRunnerManager`
-Manage a group of runners according to configuration.
-
-
-
-**Attributes:**
-
- - `runner_bin_path`: The github runner app scripts path.
- - `cron_path`: The path to runner build image cron job.
-
-
-
-### function `__init__`
-
-```python
-__init__(
- app_name: str,
- unit: int,
- runner_manager_config: LXDRunnerManagerConfig
-) → None
-```
-
-Construct RunnerManager object for creating and managing runners.
-
-
-
-**Args:**
-
- - `app_name`: An name for the set of runners.
- - `unit`: Unit number of the set of runners.
- - `runner_manager_config`: Configuration for the runner manager.
-
-
-
-
----
-
-
-
-### function `build_runner_image`
-
-```python
-build_runner_image() → None
-```
-
-Build the LXD image for hosting runner.
-
-Build container image in test mode, else virtual machine image.
-
-
-
-**Raises:**
-
- - `SubprocessError`: Unable to build the LXD image.
-
----
-
-
-
-### function `check_runner_bin`
-
-```python
-check_runner_bin() → bool
-```
-
-Check if runner binary exists.
-
-
-
-**Returns:**
- Whether runner bin exists.
-
----
-
-
-
-### function `flush`
-
-```python
-flush(mode: LXDFlushMode =
-
-### function `get_github_info`
-
-```python
-get_github_info() → Iterator[RunnerInfo]
-```
-
-Get information on the runners from GitHub.
-
-
-
-**Returns:**
- List of information from GitHub on runners.
-
----
-
-
-
-### function `get_latest_runner_bin_url`
-
-```python
-get_latest_runner_bin_url(os_name: str = 'linux') → RunnerApplication
-```
-
-Get the URL for the latest runner binary.
-
-The runner binary URL changes when a new version is available.
-
-
-
-**Args:**
-
- - `os_name`: Name of operating system.
-
-
-
-**Raises:**
-
- - `RunnerBinaryError`: If an error occurred while fetching runner application info.
-
-
-
-**Returns:**
- Information on the runner application.
-
----
-
-
-
-### function `has_runner_image`
-
-```python
-has_runner_image() → bool
-```
-
-Check if the runner image exists.
-
-
-
-**Returns:**
- Whether the runner image exists.
-
----
-
-
-
-### function `reconcile`
-
-```python
-reconcile(quantity: int, resources: VirtualMachineResources) → int
-```
-
-Bring runners in line with target.
-
-
-
-**Args:**
-
- - `quantity`: Number of intended runners.
- - `resources`: Configuration of the virtual machine resources.
-
-
-
-**Returns:**
- Difference between intended runners and actual runners.
-
----
-
-
-
-### function `schedule_build_runner_image`
-
-```python
-schedule_build_runner_image() → None
-```
-
-Install cron job for building runner image.
-
----
-
-
-
-### function `update_runner_bin`
-
-```python
-update_runner_bin(binary: RunnerApplication) → None
-```
-
-Download a runner file, replacing the current copy.
-
-Remove the existing runner binary to prevent it from being used. This is done to prevent security issues arising from outdated runner binaries containing security flaws. The newest version of runner binary should always be used.
-
-
-
-**Args:**
-
- - `binary`: Information on the runner binary to download.
-
-
-
-**Raises:**
-
- - `RunnerBinaryError`: If there was an error updating runner binary info.
-
-
diff --git a/src-docs/runner_manager_type.py.md b/src-docs/runner_manager_type.py.md
deleted file mode 100644
index 7cb3b71c6..000000000
--- a/src-docs/runner_manager_type.py.md
+++ /dev/null
@@ -1,96 +0,0 @@
-
-
-
-
-# module `runner_manager_type.py`
-Types used by RunnerManager class.
-
-
-
----
-
-## class `LXDFlushMode`
-Strategy for flushing runners.
-
-During pre-job (repo-check), the runners are marked as idle and if the pre-job fails, the runner falls back to being idle again. Hence wait_repo_check is required.
-
-
-
-**Attributes:**
-
- - `FLUSH_IDLE`: Flush only idle runners.
- - `FLUSH_IDLE_WAIT_REPO_CHECK`: Flush only idle runners, then wait until repo-policy-check is completed for the busy runners.
- - `FLUSH_BUSY`: Flush busy runners.
- - `FLUSH_BUSY_WAIT_REPO_CHECK`: Wait until the repo-policy-check is completed before flush of busy runners.
- - `FORCE_FLUSH_WAIT_REPO_CHECK`: Force flush the runners (remove lxd instances even on gh api issues, like invalid token). Wait until repo-policy-check is completed before force flush of busy runners.
-
-
-
-
-
----
-
-## class `LXDRunnerManagerConfig`
-Configuration of runner manager.
-
-
-
-**Attributes:**
-
- - `are_metrics_enabled`: Whether metrics for the runners should be collected.
- - `charm_state`: The state of the charm.
- - `image`: Name of the image for creating LXD instance.
- - `lxd_storage_path`: Path to be used as LXD storage.
- - `path`: GitHub repository path in the format '
-
-# module `runner_type.py`
-Types used by Runner class.
-
-
-
----
-
-## class `ProxySetting`
-Represent HTTP-related proxy settings.
-
-
-
-**Attributes:**
-
- - `no_proxy`: The comma separated URLs to not go through proxy.
- - `http`: HTTP proxy URL.
- - `https`: HTTPS proxy URL.
- - `aproxy_address`: Aproxy URL.
-
-
-
-
-
----
-
-## class `RunnerConfig`
-Configuration for runner.
-
-
-
-**Attributes:**
-
- - `app_name`: Application name of the charm.
- - `issue_metrics`: Whether to issue metrics.
- - `labels`: Custom runner labels.
- - `lxd_storage_path`: Path to be used as LXD storage.
- - `name`: Name of the runner.
- - `path`: GitHub repository path in the format '
-
-# module `shared_fs.py`
-Classes and functions to operate on the shared filesystem between the charm and the runners.
-
-**Global Variables**
----------------
-- **DIR_NO_MOUNTPOINT_EXIT_CODE**
-- **FILESYSTEM_OWNER**
-- **FILESYSTEM_SIZE**
-
----
-
-
-
-## function `create`
-
-```python
-create(runner_name: str) → MetricsStorage
-```
-
-Create a shared filesystem for the runner.
-
-The method is not idempotent and will raise an exception if the shared filesystem already exists.
-
-
-
-**Args:**
-
- - `runner_name`: The name of the runner.
-
-
-
-**Returns:**
- The shared filesystem object.
-
-
-
-**Raises:**
-
- - `CreateMetricsStorageError`: If the creation of the shared filesystem fails.
-
-
----
-
-
-
-## function `list_all`
-
-```python
-list_all() → Iterator[MetricsStorage]
-```
-
-List all the metric storages.
-
-
-
-**Yields:**
- A metrics storage object.
-
-
----
-
-
-
-## function `get`
-
-```python
-get(runner_name: str) → MetricsStorage
-```
-
-Get the shared filesystem for the runner.
-
-Mounts the filesystem if it is not currently mounted.
-
-
-
-**Args:**
-
- - `runner_name`: The name of the runner.
-
-
-
-**Returns:**
- The shared filesystem object.
-
-
-
-**Raises:**
-
- - `GetMetricsStorageError`: If the shared filesystem could not be retrieved/mounted.
-
-
----
-
-
-
-## function `delete`
-
-```python
-delete(runner_name: str) → None
-```
-
-Delete the shared filesystem for the runner.
-
-
-
-**Args:**
-
- - `runner_name`: The name of the runner.
-
-
-
-**Raises:**
-
- - `DeleteMetricsStorageError`: If the shared filesystem could not be deleted.
-
-
----
-
-
-
-## function `move_to_quarantine`
-
-```python
-move_to_quarantine(runner_name: str) → None
-```
-
-Archive the mshared filesystem for the runner and delete it.
-
-
-
-**Args:**
-
- - `runner_name`: The name of the runner.
-
-
diff --git a/src-docs/utilities.py.md b/src-docs/utilities.py.md
index 75a3c0386..3ba494c15 100644
--- a/src-docs/utilities.py.md
+++ b/src-docs/utilities.py.md
@@ -74,37 +74,7 @@ Looks for all upper-case and all low-case of the `env_var`.
---
-
-
-## function `bytes_with_unit_to_kib`
-
-```python
-bytes_with_unit_to_kib(num_bytes: str) → int
-```
-
-Convert a positive integer followed by a unit to number of kibibytes.
-
-
-
-**Args:**
-
- - `num_bytes`: A positive integer followed by one of the following unit: KiB, MiB, GiB, TiB, PiB, EiB.
-
-
-
-**Raises:**
-
- - `ValueError`: If invalid unit was detected.
-
-
-
-**Returns:**
- Number of kilobytes.
-
-
----
-
-
+
## function `remove_residual_venv_dirs`
diff --git a/src/charm.py b/src/charm.py
index 7cd8785ae..643f977ff 100755
--- a/src/charm.py
+++ b/src/charm.py
@@ -3,11 +3,8 @@
# Copyright 2024 Canonical Ltd.
# See LICENSE file for licensing details.
-# TODO: 2024-03-12 The module contains too many lines which are scheduled for refactoring.
-# pylint: disable=too-many-lines
-
"""Charm for creating and managing GitHub self-hosted runner instances."""
-from utilities import bytes_with_unit_to_kib, execute_command, remove_residual_venv_dirs, retry
+from utilities import execute_command, remove_residual_venv_dirs
# This is a workaround for https://bugs.launchpad.net/juju/+bug/2058335
# It is important that this is run before importation of any other modules.
@@ -18,14 +15,8 @@
import functools
import logging
-import os
-import secrets
-import shutil
-import urllib.error
-from pathlib import Path
-from typing import Any, Callable, Dict, Sequence, TypeVar
-
-import jinja2
+from typing import Any, Callable, Sequence, TypeVar
+
import ops
from charms.data_platform_libs.v0.data_interfaces import DatabaseRequires
from charms.grafana_agent.v0.cos_agent import COSAgentProvider
@@ -49,7 +40,7 @@
from github_runner_manager.reactive.types_ import QueueConfig as ReactiveQueueConfig
from github_runner_manager.reactive.types_ import RunnerConfig as ReactiveRunnerConfig
from github_runner_manager.types_ import SystemUserConfig
-from github_runner_manager.types_.github import GitHubPath, GitHubRunnerStatus, parse_github_path
+from github_runner_manager.types_.github import GitHubPath
from ops.charm import (
ActionEvent,
CharmBase,
@@ -67,36 +58,23 @@
import logrotate
from charm_state import (
DEBUG_SSH_INTEGRATION_NAME,
- GROUP_CONFIG_NAME,
IMAGE_INTEGRATION_NAME,
LABELS_CONFIG_NAME,
PATH_CONFIG_NAME,
RECONCILE_INTERVAL_CONFIG_NAME,
- TEST_MODE_CONFIG_NAME,
TOKEN_CONFIG_NAME,
CharmConfigInvalidError,
CharmState,
- InstanceType,
OpenstackImage,
- ProxyConfig,
- RunnerStorage,
- VirtualMachineResources,
)
from errors import (
ConfigurationError,
LogrotateSetupError,
MissingMongoDBError,
- MissingRunnerBinaryError,
- RunnerBinaryError,
- RunnerError,
SubprocessError,
TokenError,
)
from event_timer import EventTimer, TimerStatusError
-from firewall import Firewall, FirewallEntry
-from runner import LXD_PROFILE_YAML
-from runner_manager import LXDRunnerManager, LXDRunnerManagerConfig
-from runner_manager_type import LXDFlushMode
# We assume a stuck reconcile event when it takes longer
# than 10 times a normal interval. Currently, we are only aware of
@@ -159,12 +137,6 @@ def func_with_catch_errors(self: "GithubRunnerCharm", event: EventT) -> None:
except TokenError as err:
logger.exception("Issue with GitHub token")
self.unit.status = BlockedStatus(str(err))
- except MissingRunnerBinaryError:
- logger.exception("Missing runner binary")
- self.unit.status = MaintenanceStatus(
- "GitHub runner application not downloaded; the charm will retry download on "
- "reconcile interval"
- )
except MissingMongoDBError as err:
logger.exception("Missing integration data")
self.unit.status = WaitingStatus(str(err))
@@ -198,41 +170,15 @@ def func_with_catch_errors(self: "GithubRunnerCharm", event: ActionEvent) -> Non
logger.exception("Issue with charm configuration")
self.unit.status = BlockedStatus(str(err))
event.fail(str(err))
- except MissingRunnerBinaryError:
- logger.exception("Missing runner binary")
- err_msg = (
- "GitHub runner application not downloaded; the charm will retry download on "
- "reconcile interval"
- )
- self.unit.status = MaintenanceStatus(err_msg)
- event.fail(err_msg)
return func_with_catch_errors
class GithubRunnerCharm(CharmBase):
- """Charm for managing GitHub self-hosted runners.
-
- Attributes:
- service_token_path: The path to token to access local services.
- repo_check_web_service_path: The path to repo-policy-compliance service directory.
- repo_check_web_service_script: The path to repo-policy-compliance web service script.
- repo_check_systemd_service: The path to repo-policy-compliance unit file.
- juju_storage_path: The path to juju storage.
- ram_pool_path: The path to memdisk storage.
- kernel_module_path: The path to kernel modules.
- """
+ """Charm for managing GitHub self-hosted runners."""
_stored = StoredState()
- service_token_path = Path("service_token")
- repo_check_web_service_path = Path("/home/ubuntu/repo_policy_compliance_service")
- repo_check_web_service_script = Path("scripts/repo_policy_compliance_service.py")
- repo_check_systemd_service = Path("/etc/systemd/system/repo-policy-compliance.service")
- juju_storage_path = Path("/storage/juju")
- ram_pool_path = Path("/storage/ram")
- kernel_module_path = Path("/etc/modules")
-
def __init__(self, *args: Any, **kwargs: Any) -> None:
"""Construct the charm.
@@ -240,26 +186,16 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
args: List of arguments to be passed to the `CharmBase` class.
kwargs: List of keyword arguments to be passed to the `CharmBase`
class.
-
- Raises:
- RuntimeError: If invalid test configuration was detected.
"""
super().__init__(*args, **kwargs)
self._grafana_agent = COSAgentProvider(self)
- self.service_token: str | None = None
self._event_timer = EventTimer(self.unit.name)
- if LXD_PROFILE_YAML.exists():
- if self.config.get(TEST_MODE_CONFIG_NAME) != "insecure":
- raise RuntimeError("lxd-profile.yaml detected outside test mode")
- logger.critical("test mode is enabled")
-
self._stored.set_default(
path=self.config[PATH_CONFIG_NAME], # for detecting changes
token=self.config[TOKEN_CONFIG_NAME], # for detecting changes
labels=self.config[LABELS_CONFIG_NAME], # for detecting changes
- runner_bin_url=None,
)
self.on.define_event("reconcile_runners", ReconcileRunnersEvent)
@@ -309,149 +245,9 @@ def _setup_state(self) -> CharmState:
except CharmConfigInvalidError as exc:
raise ConfigurationError(exc.msg) from exc
- def _create_memory_storage(self, path: Path, size: int) -> None:
- """Create a tmpfs-based LVM volume group.
-
- Args:
- path: Path to directory for memory storage.
- size: Size of the tmpfs in kilobytes.
-
- Raises:
- RunnerError: Unable to setup storage for runner.
- """
- if size <= 0:
- return
-
- try:
- # Create tmpfs if not exists, else resize it.
- if not path.exists():
- path.mkdir(parents=True, exist_ok=True)
- execute_command(
- ["mount", "-t", "tmpfs", "-o", f"size={size}k", "tmpfs", str(path)]
- )
- else:
- execute_command(["mount", "-o", f"remount,size={size}k", str(path)])
- except (OSError, SubprocessError) as err:
- logger.exception("Unable to setup storage directory")
- # Remove the path if is not in use. If the tmpfs is in use, the removal will fail.
- if path.exists():
- shutil.rmtree(path, ignore_errors=True)
- path.rmdir()
- logger.info("Cleaned up storage directory")
- raise RunnerError("Failed to configure runner storage") from err
-
- @retry(tries=5, delay=5, max_delay=60, backoff=2, local_logger=logger)
- def _ensure_runner_storage(self, size: int, runner_storage: RunnerStorage) -> Path:
- """Ensure the runner storage is setup.
-
- Args:
- size: Size of the storage needed in kibibytes.
- runner_storage: Type of storage to use for virtual machine hosting the runners.
-
- Raises:
- ConfigurationError: If there was an error with runner stoarge configuration.
-
- Returns:
- Runner storage path.
- """
- match runner_storage:
- case RunnerStorage.MEMORY:
- logger.info("Creating tmpfs storage")
- path = self.ram_pool_path
- self._create_memory_storage(self.ram_pool_path, size)
- case RunnerStorage.JUJU_STORAGE:
- path = self.juju_storage_path
-
- # tmpfs storage is not created if required size is 0.
- if size > 0:
- # Check if the storage mounted has enough space
- disk = shutil.disk_usage(path)
- # Some storage space might be used by existing runners.
- if size * 1024 > disk.total:
- raise ConfigurationError(
- (
- f"Required disk space for runners {size / 1024}MiB is greater than "
- f"storage total size {disk.total / 1024 / 1024}MiB"
- )
- )
- return path
-
- @retry(tries=5, delay=5, max_delay=60, backoff=2, local_logger=logger)
- def _ensure_service_health(self) -> None:
- """Ensure services managed by the charm is healthy.
-
- Services managed include:
- * repo-policy-compliance
-
- Raises:
- SubprocessError: if there was an error starting repo-policy-compliance service.
- """
- logger.info("Checking health of repo-policy-compliance service")
- try:
- execute_command(["/usr/bin/systemctl", "is-active", "repo-policy-compliance"])
- except SubprocessError:
- logger.exception("Found inactive repo-policy-compliance service.")
- execute_command(["/usr/bin/systemctl", "restart", "repo-policy-compliance"])
- logger.info("Restart repo-policy-compliance service")
- raise
-
- def _get_runner_manager(
- self, state: CharmState, token: str | None = None, path: GitHubPath | None = None
- ) -> LXDRunnerManager:
- """Get a RunnerManager instance.
-
- Args:
- state: Charm state.
- token: GitHub personal access token to manage the runners with. If None the token in
- charm state is used.
- path: GitHub repository path in the format 'Unable to connect
- #Tinyproxy was unable to connect to the remote web server.
- #- #
Generated by tinyproxy version 1.11.0.
- # - # - return_code, stdout, stderr = await _curl_as_ubuntu_user( - unit, - runner_name, - f"http://canonical.com:{NON_STANDARD_PORT}", - ) - assert return_code == 0, ( - f"Expected error response from proxy for http://canonical.com:{NON_STANDARD_PORT}. " - f"Error msg: {stdout} {stderr}" - ) - - proxy_logs = proxy_logs_filepath.read_text(encoding="utf-8") - assert "GET http://canonical.com/" in proxy_logs - assert f"GET http://canonical.com:{NON_STANDARD_PORT}/" in proxy_logs - - aproxy_logs = await _get_aproxy_logs(unit, runner_name) - assert aproxy_logs is None diff --git a/tests/integration/test_debug_ssh.py b/tests/integration/test_debug_ssh.py index d153b6591..eefaf5854 100644 --- a/tests/integration/test_debug_ssh.py +++ b/tests/integration/test_debug_ssh.py @@ -10,8 +10,8 @@ from juju.application import Application from juju.model import Model -from charm_state import DENYLIST_CONFIG_NAME -from tests.integration.helpers.common import InstanceHelper, dispatch_workflow, get_job_logs +from tests.integration.helpers.common import dispatch_workflow, get_job_logs +from tests.integration.helpers.openstack import OpenStackInstanceHelper from tests.status_name import ACTIVE logger = logging.getLogger(__name__) @@ -27,30 +27,19 @@ async def test_ssh_debug( github_repository: Repository, test_github_branch: Branch, tmate_ssh_server_unit_ip: str, - instance_helper: InstanceHelper, + instance_helper: OpenStackInstanceHelper, ): """ - arrange: given an integrated GitHub-Runner charm and tmate-ssh-server charm with a denylist \ - covering ip ranges of tmate-ssh-server. + arrange: given an integrated GitHub-Runner charm and tmate-ssh-server charm. act: when canonical/action-tmate is triggered. assert: the ssh connection info from action-log and tmate-ssh-server matches. """ - await app_no_wait_tmate.set_config( - { - DENYLIST_CONFIG_NAME: ( - "0.0.0.0/8,10.0.0.0/8,100.64.0.0/10,169.254.0.0/16," - "172.16.0.0/12,192.0.0.0/24,192.0.2.0/24,192.88.99.0/24,192.168.0.0/16," - "198.18.0.0/15,198.51.100.0/24,203.0.113.0/24,224.0.0.0/4,233.252.0.0/24," - "240.0.0.0/4" - ), - } - ) await model.wait_for_idle(status=ACTIVE, timeout=60 * 120) unit = app_no_wait_tmate.units[0] # We need the runner to connect to the current machine, instead of the tmate_ssh_server unit, # as the tmate_ssh_server is not routable. - dnat_comman_in_runner = "sudo iptables -t nat -A OUTPUT -p tcp --dport 10022 -j DNAT --to-destination 127.0.0.1:10022" + dnat_comman_in_runner = f"sudo iptables -t nat -A OUTPUT -p tcp -d {tmate_ssh_server_unit_ip} --dport 10022 -j DNAT --to-destination 127.0.0.1:10022" _, _, _ = await instance_helper.run_in_instance( unit, dnat_comman_in_runner, diff --git a/tests/integration/test_e2e.py b/tests/integration/test_e2e.py index bed193216..ffc371649 100644 --- a/tests/integration/test_e2e.py +++ b/tests/integration/test_e2e.py @@ -9,19 +9,18 @@ from juju.application import Application from juju.model import Model -from charm_state import InstanceType from tests.integration.helpers.common import ( DISPATCH_E2E_TEST_RUN_WORKFLOW_FILENAME, - InstanceHelper, dispatch_workflow, ) +from tests.integration.helpers.openstack import OpenStackInstanceHelper @pytest_asyncio.fixture(scope="function", name="app") async def app_fixture( model: Model, basic_app: Application, - instance_helper: InstanceHelper, + instance_helper: OpenStackInstanceHelper, ) -> AsyncIterator[Application]: """Setup and teardown the charm after each test. @@ -39,24 +38,17 @@ async def test_e2e_workflow( app: Application, github_repository: Repository, test_github_branch: Branch, - instance_type: InstanceType, ): """ arrange: An app connected to an OpenStack cloud with no runners. act: Run e2e test workflow. assert: No exception thrown. """ - virt_type: str - if instance_type == InstanceType.OPENSTACK: - virt_type = "openstack" - else: - virt_type = "lxd" - await dispatch_workflow( app=app, branch=test_github_branch, github_repository=github_repository, conclusion="success", workflow_id_or_name=DISPATCH_E2E_TEST_RUN_WORKFLOW_FILENAME, - dispatch_input={"runner-tag": app.name, "runner-virt-type": virt_type}, + dispatch_input={"runner-tag": app.name}, ) diff --git a/tests/integration/test_reactive.py b/tests/integration/test_reactive.py index f99e3ff24..e3bf41928 100644 --- a/tests/integration/test_reactive.py +++ b/tests/integration/test_reactive.py @@ -57,6 +57,7 @@ async def app_fixture( await reconcile(app_for_reactive, app_for_reactive.model) +@pytest.mark.abort_on_fail async def test_reactive_mode_spawns_runner( ops_test: OpsTest, app: Application, @@ -123,6 +124,7 @@ async def _runner_installed_in_metrics_log() -> bool: await _assert_metrics_are_logged(app, github_repository) +@pytest.mark.abort_on_fail async def test_reactive_mode_does_not_consume_jobs_with_unsupported_labels( ops_test: OpsTest, app: Application, @@ -160,6 +162,7 @@ async def test_reactive_mode_does_not_consume_jobs_with_unsupported_labels( run.cancel() # cancel the run to avoid a queued run in GitHub actions page +@pytest.mark.abort_on_fail async def test_reactive_mode_scale_down( ops_test: OpsTest, app: Application, diff --git a/tests/integration/test_self_hosted_runner.py b/tests/integration/test_self_hosted_runner.py deleted file mode 100644 index 46c8280b1..000000000 --- a/tests/integration/test_self_hosted_runner.py +++ /dev/null @@ -1,192 +0,0 @@ -# Copyright 2024 Canonical Ltd. -# See LICENSE file for licensing details. - -"""Integration tests for self-hosted runner managed by the github-runner charm.""" - -from datetime import datetime, timezone -from time import sleep - -import github -import pytest -from github.Repository import Repository -from github_runner_manager.types_.github import GitHubRepo -from juju.application import Application -from juju.model import Model - -from charm_state import ( - DOCKERHUB_MIRROR_CONFIG_NAME, - PATH_CONFIG_NAME, - VIRTUAL_MACHINES_CONFIG_NAME, -) -from github_client import GithubClient -from tests.integration.helpers.common import ( - DISPATCH_TEST_WORKFLOW_FILENAME, - DISPATCH_WAIT_TEST_WORKFLOW_FILENAME, - get_job_logs, - get_workflow_runs, - reconcile, -) -from tests.integration.helpers.lxd import ( - get_runner_names, - run_in_lxd_instance, - wait_till_num_of_runners, -) -from tests.status_name import ACTIVE - - -@pytest.mark.asyncio -@pytest.mark.abort_on_fail -async def test_dispatch_workflow_with_dockerhub_mirror( - model: Model, app_runner: Application, github_repository: Repository -) -> None: - """ - arrange: A working application with no runners. - act: - 1. Set dockerhub-mirror config and spawn one runner. - 2. Dispatch a workflow. - assert: - 1. registry-mirrors is setup in /etc/docker/daemon.json of runner. - 2. Message about dockerhub_mirror appears in logs. - """ - start_time = datetime.now(timezone.utc) - - unit = app_runner.units[0] - - fake_url = "https://example.com:5000" - - # 1. - await app_runner.set_config( - {VIRTUAL_MACHINES_CONFIG_NAME: "1", DOCKERHUB_MIRROR_CONFIG_NAME: fake_url} - ) - action = await unit.run_action("reconcile-runners") - await action.wait() - await model.wait_for_idle(status=ACTIVE) - names = await get_runner_names(unit) - assert len(names) == 1 - - runner_to_be_used = names[0] - - return_code, stdout, stderr = await run_in_lxd_instance( - unit, runner_to_be_used, "cat /etc/docker/daemon.json" - ) - assert return_code == 0, f"Failed to get docker daemon contents, {stdout} {stderr}" - assert stdout is not None - assert "registry-mirrors" in stdout - assert fake_url in stdout - - # 2. - main_branch = github_repository.get_branch(github_repository.default_branch) - workflow = github_repository.get_workflow(id_or_file_name=DISPATCH_TEST_WORKFLOW_FILENAME) - - workflow.create_dispatch(main_branch, {"runner": app_runner.name}) - - # Wait until the runner is used up. - for _ in range(30): - runners = await get_runner_names(unit) - if runner_to_be_used not in runners: - break - sleep(30) - else: - assert False, "Timeout while waiting for workflow to complete" - - # Unable to find the run id of the workflow that was dispatched. - # Therefore, all runs after this test start should pass the conditions. - for run in get_workflow_runs(start_time, workflow, runner_to_be_used): - jobs = run.jobs() - try: - logs = get_job_logs(jobs[0]) - except github.GithubException.GithubException: - continue - - if f"Job is about to start running on the runner: {app_runner.name}-" in logs: - assert run.jobs()[0].conclusion == "success" - assert ( - "A private docker registry is setup as a dockerhub mirror for this self-hosted" - " runner." - ) in logs - - -@pytest.mark.asyncio -@pytest.mark.abort_on_fail -async def test_flush_busy_runner( - model: Model, - app_runner: Application, - forked_github_repository: Repository, - runner_manager_github_client: GithubClient, -) -> None: - """ - arrange: A working application with one runner. - act: - 1. Dispatch a workflow that waits for 30 mins. - 2. Run flush-runners action. - assert: - 1. The runner is in busy status. - 2. a. The flush-runners action should take less than the timeout. - b. The runner should be flushed. - """ - unit = app_runner.units[0] - - config = await app_runner.get_config() - - await app_runner.set_config( - {PATH_CONFIG_NAME: forked_github_repository.full_name, VIRTUAL_MACHINES_CONFIG_NAME: "1"} - ) - await reconcile(app=app_runner, model=model) - await wait_till_num_of_runners(unit, 1) - - names = await get_runner_names(unit) - assert len(names) == 1 - - runner_to_be_used = names[0] - - # 1. - main_branch = forked_github_repository.get_branch(forked_github_repository.default_branch) - workflow = forked_github_repository.get_workflow( - id_or_file_name=DISPATCH_WAIT_TEST_WORKFLOW_FILENAME - ) - - assert workflow.create_dispatch(main_branch, {"runner": app_runner.name, "minutes": "30"}) - - # Wait until runner online and then busy. - for _ in range(30): - all_runners = runner_manager_github_client.get_runner_github_info( - GitHubRepo( - owner=forked_github_repository.owner.login, repo=forked_github_repository.name - ) - ) - runners = [runner for runner in all_runners if runner.name == runner_to_be_used] - - if not runners: - # if runner is not online yet. - sleep(30) - continue - - assert len(runners) == 1, "Should not occur as GitHub enforce unique naming of runner" - runner = runners[0] - if runner["busy"]: - start_time = datetime.now(timezone.utc) - break - - sleep(30) - else: - assert False, "Timeout while waiting for runner to take up the workflow" - - # 2. - action = await unit.run_action("flush-runners") - await action.wait() - - end_time = datetime.now(timezone.utc) - - # The flushing of runner should take less than the 30 minutes timeout of the workflow. - diff = end_time - start_time - assert diff.total_seconds() < 30 * 60 - - names = await get_runner_names(unit) - assert runner_to_be_used not in names, "Found a runner that should be flushed" - - # Ensure the app_runner is back to 0 runners. - await app_runner.set_config( - {VIRTUAL_MACHINES_CONFIG_NAME: "0", PATH_CONFIG_NAME: config[PATH_CONFIG_NAME]} - ) - await reconcile(app=app_runner, model=model) - await wait_till_num_of_runners(unit, 0) diff --git a/tests/unit/conftest.py b/tests/unit/conftest.py index 5a9182080..bb06bf614 100644 --- a/tests/unit/conftest.py +++ b/tests/unit/conftest.py @@ -11,7 +11,7 @@ from github_runner_manager.manager.runner_scaler import RunnerScaler import utilities -from tests.unit.mock import MockGhapiClient, MockLxdClient, MockRepoPolicyComplianceClient +from tests.unit.mock import MockGhapiClient @pytest.fixture(name="exec_command") @@ -19,16 +19,6 @@ def exec_command_fixture(): return unittest.mock.MagicMock(return_value=("", 0)) -@pytest.fixture(name="lxd_exec_command") -def lxd_exec_command_fixture(): - return unittest.mock.MagicMock(return_value=("", 0)) - - -@pytest.fixture(name="runner_binary_path") -def runner_binary_path_fixture(tmp_path): - return tmp_path / "github-runner-app" - - def disk_usage_mock(total_disk: int): """Mock disk usage factory. @@ -45,54 +35,21 @@ def disk_usage_mock(total_disk: int): @pytest.fixture(autouse=True) -def mocks(monkeypatch, tmp_path, exec_command, lxd_exec_command, runner_binary_path): +def mocks(monkeypatch, tmp_path, exec_command): runner_scaler_mock = unittest.mock.MagicMock(spec=RunnerScaler) cron_path = tmp_path / "cron.d" cron_path.mkdir() - monkeypatch.setattr( - "charm.GithubRunnerCharm.service_token_path", tmp_path / "mock_service_token" - ) - monkeypatch.setattr( - "charm.GithubRunnerCharm.repo_check_web_service_path", - tmp_path / "repo_policy_compliance_service", - ) - monkeypatch.setattr( - "charm.GithubRunnerCharm.repo_check_systemd_service", tmp_path / "systemd_service" - ) monkeypatch.setattr("charm.RunnerScaler", runner_scaler_mock) - monkeypatch.setattr("charm.GithubRunnerCharm.kernel_module_path", tmp_path / "modules") - monkeypatch.setattr("charm.GithubRunnerCharm._update_kernel", lambda self, now: None) monkeypatch.setattr("charm.execute_command", exec_command) - monkeypatch.setattr("charm.shutil", unittest.mock.MagicMock()) - monkeypatch.setattr("charm.shutil.disk_usage", disk_usage_mock(30 * 1024 * 1024 * 1024)) monkeypatch.setattr("charm_state.CHARM_STATE_PATH", Path(tmp_path / "charm_state.json")) monkeypatch.setattr("event_timer.jinja2", unittest.mock.MagicMock()) monkeypatch.setattr("event_timer.execute_command", exec_command) - monkeypatch.setattr( - "firewall.Firewall.get_host_ip", unittest.mock.MagicMock(return_value="10.0.0.1") - ) - monkeypatch.setattr("firewall.Firewall.refresh_firewall", unittest.mock.MagicMock()) - monkeypatch.setattr("runner.execute_command", lxd_exec_command) - monkeypatch.setattr("runner.shared_fs", unittest.mock.MagicMock()) monkeypatch.setattr( "github_runner_manager.metrics.events.METRICS_LOG_PATH", Path(tmp_path / "metrics.log") ) - monkeypatch.setattr("runner.time", unittest.mock.MagicMock()) monkeypatch.setattr("github_runner_manager.github_client.GhApi", MockGhapiClient) - monkeypatch.setattr("runner_manager_type.jinja2", unittest.mock.MagicMock()) - monkeypatch.setattr("runner_manager_type.LxdClient", MockLxdClient) - monkeypatch.setattr("runner_manager.github_metrics", unittest.mock.MagicMock()) - monkeypatch.setattr("runner_manager.runner_logs", unittest.mock.MagicMock()) - monkeypatch.setattr("runner_manager.LxdClient", MockLxdClient) - monkeypatch.setattr("runner_manager.shared_fs", unittest.mock.MagicMock()) - monkeypatch.setattr("runner_manager.execute_command", exec_command) - monkeypatch.setattr("runner_manager.LXDRunnerManager.runner_bin_path", runner_binary_path) - monkeypatch.setattr("runner_manager.LXDRunnerManager.cron_path", cron_path) - monkeypatch.setattr( - "runner_manager.RepoPolicyComplianceClient", MockRepoPolicyComplianceClient - ) monkeypatch.setattr("github_runner_manager.utilities.time", unittest.mock.MagicMock()) diff --git a/tests/unit/factories.py b/tests/unit/factories.py index 2dc9d2a97..fff8cbdb0 100644 --- a/tests/unit/factories.py +++ b/tests/unit/factories.py @@ -7,6 +7,7 @@ # pylint: disable=too-few-public-methods import random +import secrets from typing import Generic, TypeVar from unittest.mock import MagicMock @@ -14,12 +15,12 @@ import factory.fuzzy import invoke.runners import openstack.compute.v2.server +import yaml from pydantic.networks import IPvAnyAddress from charm_state import ( COS_AGENT_INTEGRATION_NAME, DEBUG_SSH_INTEGRATION_NAME, - DENYLIST_CONFIG_NAME, DOCKERHUB_MIRROR_CONFIG_NAME, GROUP_CONFIG_NAME, LABELS_CONFIG_NAME, @@ -29,14 +30,10 @@ OPENSTACK_NETWORK_CONFIG_NAME, PATH_CONFIG_NAME, RECONCILE_INTERVAL_CONFIG_NAME, - RUNNER_STORAGE_CONFIG_NAME, TEST_MODE_CONFIG_NAME, TOKEN_CONFIG_NAME, USE_APROXY_CONFIG_NAME, VIRTUAL_MACHINES_CONFIG_NAME, - VM_CPU_CONFIG_NAME, - VM_DISK_CONFIG_NAME, - VM_MEMORY_CONFIG_NAME, SSHDebugConnection, ) @@ -127,23 +124,34 @@ class Meta: model = factory.SubFactory(MockGithubRunnerCharmModelFactory) config = factory.Dict( { - DENYLIST_CONFIG_NAME: "", DOCKERHUB_MIRROR_CONFIG_NAME: "", GROUP_CONFIG_NAME: "default", LABELS_CONFIG_NAME: "", - OPENSTACK_CLOUDS_YAML_CONFIG_NAME: "", + OPENSTACK_CLOUDS_YAML_CONFIG_NAME: yaml.safe_dump( + { + "clouds": { + "openstack": { + "auth": { + "auth_url": "https://project-keystone.url/", + "password": secrets.token_hex(16), + "project_domain_name": "Default", + "project_name": "test-project-name", + "user_domain_name": "Default", + "username": "test-user-name", + }, + "region_name": secrets.token_hex(16), + } + } + } + ), OPENSTACK_NETWORK_CONFIG_NAME: "external", OPENSTACK_FLAVOR_CONFIG_NAME: "m1.small", PATH_CONFIG_NAME: factory.Sequence(lambda n: f"mock_path_{n}"), RECONCILE_INTERVAL_CONFIG_NAME: 10, - RUNNER_STORAGE_CONFIG_NAME: "juju-storage", TEST_MODE_CONFIG_NAME: "", TOKEN_CONFIG_NAME: factory.Sequence(lambda n: f"mock_token_{n}"), USE_APROXY_CONFIG_NAME: False, VIRTUAL_MACHINES_CONFIG_NAME: 1, - VM_CPU_CONFIG_NAME: 2, - VM_MEMORY_CONFIG_NAME: "7GiB", - VM_DISK_CONFIG_NAME: "10GiB", } ) diff --git a/tests/unit/mock.py b/tests/unit/mock.py index 78c0c6990..61c4c8b4b 100644 --- a/tests/unit/mock.py +++ b/tests/unit/mock.py @@ -6,17 +6,12 @@ from __future__ import annotations import hashlib -import io import logging import secrets -from pathlib import Path -from typing import IO, Optional, Sequence, Union from github_runner_manager.types_.github import RegistrationToken, RemoveToken, RunnerApplication -from errors import LxdError, RunnerError -from lxd_type import LxdNetwork -from runner import LxdInstanceConfig +from errors import RunnerError logger = logging.getLogger(__name__) @@ -32,315 +27,6 @@ ) -class MockLxdClient: - """Mock the behavior of the LXD client.""" - - def __init__(self): - """Fake init implementation for LxdClient.""" - self.instances = MockLxdInstanceManager() - self.profiles = MockLxdProfileManager() - self.networks = MockLxdNetworkManager() - self.storage_pools = MockLxdStoragePoolManager() - self.images = MockLxdImageManager() - - -class MockLxdInstanceManager: - """Mock the behavior of the LXD Instances.""" - - def __init__(self): - """Fake init implementation for LxdInstanceManager.""" - self.instances = {} - - def create(self, config: LxdInstanceConfig, wait: bool = False) -> MockLxdInstance: - """Create an instance with given config. - - Args: - config: The instance configuration to create the instance with. - wait: Placeholder for wait argument. - - Returns: - Mock instance that was created. - """ - self.instances[config["name"]] = MockLxdInstance(config["name"]) - return self.instances[config["name"]] - - def get(self, name: str): - """Get an instance with given name. - - Args: - name: The name of the instance to get. - - Returns: - Instance with given name. - """ - return self.instances[name] - - def all(self): - """Return all instances that have not been deleted. - - Returns: - All Lxd fake instances that have not been deleted. - """ - return [i for i in self.instances.values() if not i.deleted] - - -class MockLxdProfileManager: - """Mock the behavior of the LXD Profiles.""" - - def __init__(self): - """Initialization method for LxdProfileManager fake.""" - self.profiles = set() - - def create(self, name: str, config: dict[str, str], devices: dict[str, str]): - """Fake implementation of create method of LxdProfile manager. - - Args: - name: The name of LXD profile. - config: The config of LXD profile to create. - devices: The devices mapping of LXD profile to create with. - """ - self.profiles.add(name) - - def exists(self, name: str) -> bool: - """Fake implementation of exists method of LxdProfile manager. - - Args: - name: The name of LXD profile. - - Returns: - Whether given LXD profile exists. - """ - return name in self.profiles - - -class MockLxdNetworkManager: - """Mock the behavior of the LXD networks.""" - - def __init__(self): - """Placeholder for initialization method for LxdInstance stub.""" - pass - - def get(self, name: str) -> LxdNetwork: - """Stub method get for LxdNetworkManager. - - Args: - name: the name of the LxdNetwork to get. - - Returns: - LxdNetwork stub. - """ - return LxdNetwork( - "lxdbr0", "", "bridge", {"ipv4.address": "10.1.1.1/24"}, True, ("default") - ) - - -class MockLxdInstance: - """Mock the behavior of an LXD Instance.""" - - def __init__(self, name: str): - """Fake implementation of initialization method for LxdInstance fake. - - Args: - name: The mock instance name to create. - """ - self.name = name - self.status = "Stopped" - self.deleted = False - - self.files = MockLxdInstanceFileManager() - - def start(self, wait: bool = True, timeout: int = 60): - """Fake implementation of start method for LxdInstance fake. - - Args: - wait: Placeholder for wait argument. - timeout: Placeholder for timeout argument. - """ - self.status = "Running" - - def stop(self, wait: bool = True, timeout: int = 60): - """Fake implementation of stop method for LxdInstance fake. - - Args: - wait: Placeholder for wait argument. - timeout: Placeholder for timeout argument. - """ - self.status = "Stopped" - # Ephemeral virtual machine should be deleted on stop. - self.deleted = True - - def delete(self, wait: bool = True): - """Fake implementation of delete method for LxdInstance fake. - - Args: - wait: Placeholder for wait argument. - """ - self.deleted = True - - def execute( - self, cmd: Sequence[str], cwd: Optional[str] = None, hide_cmd: bool = False - ) -> tuple[int, IO, IO]: - """Implementation for execute for LxdInstance fake. - - Args: - cmd: Placeholder for command to execute. - cwd: Placeholder for working directory to execute command. - hide_cmd: Placeholder for to hide command that is being executed. - - Returns: - Empty tuples values that represent a successful command execution. - """ - return 0, io.BytesIO(b""), io.BytesIO(b"") - - -class MockLxdInstanceFileManager: - """Mock the behavior of an LXD Instance's files.""" - - def __init__(self): - """Initializer for fake instance of LxdInstanceFileManager.""" - self.files = {} - - def mk_dir(self, path): - """Placeholder for mk_dir implementation of LxdInstanceFileManager. - - Args: - path: The path to create. - """ - pass - - def push_file(self, source: str, destination: str, mode: Optional[str] = None): - """Fake push_file implementation of LxdInstanceFileManager. - - Args: - source: Placeholder argument for source file path copy from. - destination: File path to write to. - mode: Placeholder for file write mode. - """ - self.files[destination] = "mock_content" - - def write_file(self, filepath: str, data: Union[bytes, str], mode: Optional[str] = None): - """Fake write_file implementation of LxdInstanceFileManager. - - Args: - filepath: The file path to read. - data: File contents to write - mode: Placeholder for file write mode. - """ - self.files[filepath] = data - - def read_file(self, filepath: str): - """Fake read_file implementation of LxdInstanceFileManager. - - Args: - filepath: The file path to read. - - Returns: - Contents of file. - """ - return self.files.get(str(filepath), None) - - -class MockLxdStoragePoolManager: - """Mock the behavior of LXD storage pools.""" - - def __init__(self): - """Initialize fake storage pools.""" - self.pools = {} - - def all(self): - """Get all non-deleted fake lxd storage pools. - - Returns: - List of all non deleted fake LXD storages. - """ - return [pool for pool in self.pools.values() if not pool.deleted] - - def get(self, name): - """Get a fake storage pool of given name. - - Args: - name: Name of the storage pool to get. - - Returns: - Fake storage pool of given name. - """ - return self.pools[name] - - def exists(self, name): - """Check if given storage exists in the fake LxdStoragePool. - - Args: - name: Fake storage pool name to check for existence. - - Returns: - If storage pool of given name exists. - """ - if name in self.pools: - return not self.pools[name].deleted - else: - return False - - def create(self, config): - """Fake LxdStoragePoolManager create function. - - Args: - config: The LXD storage pool config. - - Returns: - Created LXDStoragePool fake. - """ - self.pools[config["name"]] = MockLxdStoragePool() - return self.pools[config["name"]] - - -class MockLxdStoragePool: - """Mock the behavior of an LXD storage pool.""" - - def __init__(self): - """LXD storage pool fake initialization method.""" - self.deleted = False - - def save(self): - """LXD storage pool fake save method placeholder.""" - pass - - def delete(self): - """LXD storage pool fake delete method.""" - self.deleted = True - - -class MockLxdImageManager: - """Mock the behavior of LXD images.""" - - def __init__(self, images: set[str] | None = None): - """Fake init implementation for LxdImageManager. - - Args: - images: Set of images to initialize. - """ - self.images: set[str] = images or set() - - def create(self, name: str, _: Path) -> None: - """Import an LXD image into the fake set. - - Args: - name: Alias for the image. - _: Path of the LXD image file. - """ - self.images.add(name) - - def exists(self, name: str) -> bool: - """Check if an image with the given name exists. - - Args: - name: image name. - - Returns: - Whether the image exists. - """ - return name in self.images - - class MockErrorResponse: """Mock of an error response for request library.""" @@ -357,19 +43,6 @@ def json(self): return {"metadata": {"err": "test error"}} -def mock_lxd_error_func(*args, **kwargs): - """A stub function that always raises LxdError. - - Args: - args: Placeholder for positional arguments. - kwargs: Placeholder for key word arguments. - - Raises: - LxdError: always. - """ - raise LxdError(MockErrorResponse()) - - def mock_runner_error_func(*args, **kwargs): """A stub function that always raises RunnerError. diff --git a/tests/unit/mock_runner_managers.py b/tests/unit/mock_runner_managers.py index b52afa538..558b8159f 100644 --- a/tests/unit/mock_runner_managers.py +++ b/tests/unit/mock_runner_managers.py @@ -7,6 +7,7 @@ from typing import Iterable, Iterator, Sequence from unittest.mock import MagicMock +from github_runner_manager.github_client import GithubClient from github_runner_manager.manager.cloud_runner_manager import ( CloudRunnerInstance, CloudRunnerManager, @@ -18,7 +19,6 @@ from github_runner_manager.types_.github import GitHubRunnerStatus, SelfHostedRunner from charm_state import GitHubPath -from github_client import GithubClient from tests.unit.mock import MockGhapiClient diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py index 7e70c6d59..7508f29be 100644 --- a/tests/unit/test_charm.py +++ b/tests/unit/test_charm.py @@ -7,15 +7,13 @@ import typing import unittest import urllib.error -from pathlib import Path -from unittest.mock import MagicMock, call, patch +from unittest.mock import MagicMock, patch import pytest import yaml from github_runner_manager.errors import ReconcileError from github_runner_manager.manager.runner_manager import FlushMode from github_runner_manager.manager.runner_scaler import RunnerScaler -from github_runner_manager.types_.github import GitHubOrg, GitHubRepo, GitHubRunnerStatus from ops.model import ActiveStatus, BlockedStatus, MaintenanceStatus, StatusBase, WaitingStatus from ops.testing import Harness @@ -27,35 +25,24 @@ catch_charm_errors, ) from charm_state import ( - GROUP_CONFIG_NAME, IMAGE_INTEGRATION_NAME, OPENSTACK_CLOUDS_YAML_CONFIG_NAME, PATH_CONFIG_NAME, - RECONCILE_INTERVAL_CONFIG_NAME, TOKEN_CONFIG_NAME, USE_APROXY_CONFIG_NAME, - VIRTUAL_MACHINES_CONFIG_NAME, - VM_CPU_CONFIG_NAME, - VM_DISK_CONFIG_NAME, Arch, - InstanceType, OpenStackCloudsYAML, OpenstackImage, - ProxyConfig, - VirtualMachineResources, ) from errors import ( ConfigurationError, LogrotateSetupError, MissingMongoDBError, - MissingRunnerBinaryError, RunnerError, SubprocessError, TokenError, ) from event_timer import EventTimer, TimerEnableError -from firewall import FirewallEntry -from runner_manager import LXDRunnerManagerConfig, RunnerInfo TEST_PROXY_SERVER_URL = "http://proxy.server:1234" @@ -126,56 +113,47 @@ def mock_download_latest_runner_image(*args): return "www.example.com" -def mock_get_github_info(): - """A stub function that returns mock Github runner information. - - Returns: - RunnerInfo with different name, statuses, busy values. - """ - return [ - RunnerInfo("test runner 0", GitHubRunnerStatus.ONLINE.value, True), - RunnerInfo("test runner 1", GitHubRunnerStatus.ONLINE.value, False), - RunnerInfo("test runner 2", GitHubRunnerStatus.OFFLINE.value, False), - RunnerInfo("test runner 3", GitHubRunnerStatus.OFFLINE.value, False), - RunnerInfo("test runner 4", "unknown", False), - ] - - -def setup_charm_harness(monkeypatch: pytest.MonkeyPatch, runner_bin_path: Path) -> Harness: +def setup_charm_harness(monkeypatch: pytest.MonkeyPatch) -> Harness: """Setup harness with patched runner manager methods. Args: monkeypatch: Instance of pytest monkeypatch for patching RunnerManager methods. - runner_bin_path: Runner binary temporary path fixture. Returns: Harness with patched RunnerManager instance. """ - - def stub_update_runner_bin(*args, **kwargs) -> None: - """Update runner bin stub function. - - Args: - args: Placeholder for positional argument values. - kwargs: Placeholder for keyword argument values. - """ - runner_bin_path.touch() - harness = Harness(GithubRunnerCharm) - harness.update_config({PATH_CONFIG_NAME: "mock/repo", TOKEN_CONFIG_NAME: "mocktoken"}) - harness.begin() - monkeypatch.setattr( - "runner_manager.LXDRunnerManager.update_runner_bin", stub_update_runner_bin + cloud_yaml = { + "clouds": { + "microstack": { + "auth": { + "auth_url": secrets.token_hex(16), + "project_name": secrets.token_hex(16), + "project_domain_name": secrets.token_hex(16), + "username": secrets.token_hex(16), + "user_domain_name": secrets.token_hex(16), + "password": secrets.token_hex(16), + }, + "region_name": secrets.token_hex(16), + } + } + } + harness.update_config( + { + PATH_CONFIG_NAME: "mock/repo", + TOKEN_CONFIG_NAME: "mocktoken", + OPENSTACK_CLOUDS_YAML_CONFIG_NAME: yaml.safe_dump(cloud_yaml), + } ) - monkeypatch.setattr("runner_manager.LXDRunnerManager._runners_in_pre_job", lambda self: False) + harness.begin() monkeypatch.setattr("charm.EventTimer.ensure_event_timer", MagicMock()) monkeypatch.setattr("charm.logrotate.setup", MagicMock()) return harness @pytest.fixture(name="harness") -def harness_fixture(monkeypatch, runner_binary_path: Path) -> Harness: - return setup_charm_harness(monkeypatch, runner_binary_path) +def harness_fixture(monkeypatch) -> Harness: + return setup_charm_harness(monkeypatch) @patch.dict( @@ -213,54 +191,16 @@ def test_common_install_code( act: Fire install/upgrade event. assert: Common install commands are run on the mock. """ - monkeypatch.setattr("charm.logrotate.setup", setup_logrotate := MagicMock()) + state_mock = MagicMock() + harness.charm._setup_state = MagicMock(return_value=state_mock) - monkeypatch.setattr( - "runner_manager.LXDRunnerManager.schedule_build_runner_image", - schedule_build_runner_image := MagicMock(), - ) + monkeypatch.setattr("charm.logrotate.setup", setup_logrotate := MagicMock()) event_timer_mock = MagicMock(spec=EventTimer) harness.charm._event_timer = event_timer_mock getattr(harness.charm.on, hook).emit() - calls = [ - call(["/usr/bin/snap", "install", "lxd", "--channel=latest/stable"]), - call(["/snap/bin/lxd", "init", "--auto"]), - call(["/usr/bin/systemctl", "enable", "repo-policy-compliance"]), - ] - exec_command.assert_has_calls(calls, any_order=True) setup_logrotate.assert_called_once() - schedule_build_runner_image.assert_called_once() - event_timer_mock.ensure_event_timer.assert_called_once() - - -@pytest.mark.parametrize( - "hook", - [ - pytest.param("install", id="Install"), - pytest.param("upgrade_charm", id="Upgrade"), - ], -) -def test_common_install_code_does_not_rebuild_image( - hook: str, harness: Harness, monkeypatch: pytest.MonkeyPatch -): - """ - arrange: Set up charm and runner manager to not have runner image. - act: Fire upgrade event. - assert: Image is not rebuilt. - """ - monkeypatch.setattr( - "runner_manager.LXDRunnerManager.build_runner_image", - build_runner_image := MagicMock(), - ) - monkeypatch.setattr( - "runner_manager.LXDRunnerManager.has_runner_image", - MagicMock(return_value=True), - ) - getattr(harness.charm.on, hook).emit() - - assert not build_runner_image.called def test_on_config_changed_failure(harness: Harness): @@ -275,36 +215,6 @@ def test_on_config_changed_failure(harness: Harness): assert "Invalid proxy configuration" in harness.charm.unit.status.message -def test_get_runner_manager(harness: Harness): - """ - arrange: Set up charm. - act: Get runner manager. - assert: Runner manager is returned with the correct config. - """ - state = harness.charm._setup_state() - runner_manager = harness.charm._get_runner_manager(state) - assert runner_manager is not None - assert runner_manager.config.token == "mocktoken" - assert runner_manager.proxies == ProxyConfig( - http=None, https=None, no_proxy=None, use_aproxy=False - ) - - -def test_on_flush_runners_action_fail(harness: Harness, runner_binary_path: Path): - """ - arrange: Set up charm without runner binary downloaded. - act: Run flush runner action. - assert: Action fail with missing runner binary. - """ - runner_binary_path.unlink(missing_ok=True) - mock_event = MagicMock() - harness.charm._on_flush_runners_action(mock_event) - mock_event.fail.assert_called_with( - "GitHub runner application not downloaded; the charm will retry download on reconcile " - "interval" - ) - - def test_on_flush_runners_reconcile_error_fail(harness: Harness): """ arrange: Set up charm with Openstack mode and ReconcileError. @@ -312,7 +222,6 @@ def test_on_flush_runners_reconcile_error_fail(harness: Harness): assert: Action fails with generic message and goes in ActiveStatus. """ state_mock = MagicMock() - state_mock.instance_type = InstanceType.OPENSTACK harness.charm._setup_state = MagicMock(return_value=state_mock) runner_scaler_mock = MagicMock(spec=RunnerScaler) @@ -326,18 +235,6 @@ def test_on_flush_runners_reconcile_error_fail(harness: Harness): assert harness.charm.unit.status.message == ACTIVE_STATUS_RECONCILIATION_FAILED_MSG -def test_on_flush_runners_action_success(harness: Harness, runner_binary_path: Path): - """ - arrange: Set up charm without runner binary downloaded. - act: Run flush runner action. - assert: Action fail with missing runner binary. - """ - mock_event = MagicMock() - runner_binary_path.touch() - harness.charm._on_flush_runners_action(mock_event) - mock_event.set_results.assert_called() - - def test_on_reconcile_runners_action_reconcile_error_fail( harness: Harness, monkeypatch: pytest.MonkeyPatch ): @@ -347,7 +244,6 @@ def test_on_reconcile_runners_action_reconcile_error_fail( assert: Action fails with generic message and goes in ActiveStatus """ state_mock = MagicMock() - state_mock.instance_type = InstanceType.OPENSTACK harness.charm._setup_state = MagicMock(return_value=state_mock) runner_scaler_mock = MagicMock(spec=RunnerScaler) @@ -374,7 +270,6 @@ def test_on_reconcile_runners_reconcile_error(harness: Harness, monkeypatch: pyt assert: Unit goes into ActiveStatus with error message. """ state_mock = MagicMock() - state_mock.instance_type = InstanceType.OPENSTACK harness.charm._setup_state = MagicMock(return_value=state_mock) runner_scaler_mock = MagicMock(spec=RunnerScaler) @@ -400,7 +295,6 @@ def test_on_stop_busy_flush(harness: Harness, monkeypatch: pytest.MonkeyPatch): assert: Runner scaler mock flushes the runners using busy mode. """ state_mock = MagicMock() - state_mock.instance_type = InstanceType.OPENSTACK harness.charm._setup_state = MagicMock(return_value=state_mock) runner_scaler_mock = MagicMock(spec=RunnerScaler) harness.charm._get_runner_scaler = MagicMock(return_value=runner_scaler_mock) @@ -426,6 +320,8 @@ def test_on_install_failure(hook: str, harness: Harness, monkeypatch: pytest.Mon 2. Mock _install_deps raises error. assert: Charm goes into error state in both cases. """ + state_mock = MagicMock() + harness.charm._setup_state = MagicMock(return_value=state_mock) monkeypatch.setattr("charm.logrotate.setup", setup_logrotate := unittest.mock.MagicMock()) setup_logrotate.side_effect = LogrotateSetupError("Failed to setup logrotate") @@ -440,61 +336,6 @@ def test_on_install_failure(hook: str, harness: Harness, monkeypatch: pytest.Mon assert "mock stderr" in str(exc.value) -def test__refresh_firewall(monkeypatch, harness: Harness, runner_binary_path: Path): - """ - arrange: given multiple tmate-ssh-server units in relation. - act: when refresh_firewall is called. - assert: the unit ip addresses are included in allowlist. - """ - runner_binary_path.touch() - - relation_id = harness.add_relation("debug-ssh", "tmate-ssh-server") - harness.add_relation_unit(relation_id, "tmate-ssh-server/0") - harness.add_relation_unit(relation_id, "tmate-ssh-server/1") - harness.add_relation_unit(relation_id, "tmate-ssh-server/2") - test_unit_ip_addresses = ["127.0.0.1", "127.0.0.2", "127.0.0.3"] - - harness.update_relation_data( - relation_id, - "tmate-ssh-server/0", - { - "host": test_unit_ip_addresses[0], - "port": "10022", - "rsa_fingerprint": "SHA256:abcd", - "ed25519_fingerprint": "abcd", - }, - ) - harness.update_relation_data( - relation_id, - "tmate-ssh-server/1", - { - "host": test_unit_ip_addresses[1], - "port": "10022", - "rsa_fingerprint": "SHA256:abcd", - "ed25519_fingerprint": "abcd", - }, - ) - harness.update_relation_data( - relation_id, - "tmate-ssh-server/2", - { - "host": test_unit_ip_addresses[2], - "port": "10022", - "rsa_fingerprint": "SHA256:abcd", - "ed25519_fingerprint": "abcd", - }, - ) - - monkeypatch.setattr("charm.Firewall", mock_firewall := unittest.mock.MagicMock()) - state = harness.charm._setup_state() - harness.charm._refresh_firewall(state) - mocked_firewall_instance = mock_firewall.return_value - allowlist = mocked_firewall_instance.refresh_firewall.call_args_list[0][1]["allowlist"] - assert all( - FirewallEntry(ip) in allowlist for ip in test_unit_ip_addresses - ), "Expected IP firewall entry not found in allowlist arg." - - def test_charm_goes_into_waiting_state_on_missing_integration_data( monkeypatch: pytest.MonkeyPatch, harness: Harness ): @@ -541,156 +382,10 @@ def test_database_integration_events_trigger_reconciliation( class TestCharm(unittest.TestCase): """Test the GithubRunner charm.""" - @patch("charm.LXDRunnerManager") - @patch("pathlib.Path.mkdir") - @patch("pathlib.Path.write_text") - @patch("subprocess.run") - def test_org_register(self, run, wt, mkdir, rm): - harness = Harness(GithubRunnerCharm) - harness.update_config( - { - PATH_CONFIG_NAME: "mockorg", - TOKEN_CONFIG_NAME: "mocktoken", - GROUP_CONFIG_NAME: "mockgroup", - RECONCILE_INTERVAL_CONFIG_NAME: 5, - } - ) - harness.begin() - harness.charm.on.config_changed.emit() - token = harness.charm.service_token - state = harness.charm._setup_state() - rm.assert_called_with( - "github-runner", - "0", - LXDRunnerManagerConfig( - path=GitHubOrg(org="mockorg", group="mockgroup"), - token="mocktoken", - image="jammy", - service_token=token, - lxd_storage_path=GithubRunnerCharm.juju_storage_path, - charm_state=state, - ), - ) - - @patch("charm.LXDRunnerManager") - @patch("pathlib.Path.mkdir") - @patch("pathlib.Path.write_text") - @patch("subprocess.run") - def test_repo_register(self, run, wt, mkdir, rm): - harness = Harness(GithubRunnerCharm) - harness.update_config( - { - PATH_CONFIG_NAME: "mockorg/repo", - TOKEN_CONFIG_NAME: "mocktoken", - RECONCILE_INTERVAL_CONFIG_NAME: 5, - } - ) - harness.begin() - harness.charm.on.config_changed.emit() - token = harness.charm.service_token - state = harness.charm._setup_state() - rm.assert_called_with( - "github-runner", - "0", - LXDRunnerManagerConfig( - path=GitHubRepo(owner="mockorg", repo="repo"), - token="mocktoken", - image="jammy", - service_token=token, - lxd_storage_path=GithubRunnerCharm.juju_storage_path, - charm_state=state, - ), - ) - - @patch("charm.LXDRunnerManager") - @patch("pathlib.Path.mkdir") - @patch("pathlib.Path.write_text") - @patch("subprocess.run") - def test_exceed_free_disk_size(self, run, wt, mkdir, rm): - """ - arrange: Charm with 30GiB of storage for runner. - act: Configuration that uses 100GiB of disk. - assert: Charm enters block state. - """ - rm.return_value = mock_rm = MagicMock() - mock_rm.get_latest_runner_bin_url = mock_get_latest_runner_bin_url - mock_rm.download_latest_runner_image = mock_download_latest_runner_image - - harness = Harness(GithubRunnerCharm) - harness.update_config({PATH_CONFIG_NAME: "mockorg/repo", TOKEN_CONFIG_NAME: "mocktoken"}) - harness.begin() - - harness.update_config({VIRTUAL_MACHINES_CONFIG_NAME: 10}) - harness.charm.on.reconcile_runners.emit() - assert harness.charm.unit.status == BlockedStatus( - ( - "Required disk space for runners 102400.0MiB is greater than storage total size " - "30720.0MiB" - ) - ) - - @patch("charm.LXDRunnerManager") - @patch("pathlib.Path.mkdir") - @patch("pathlib.Path.write_text") - @patch("subprocess.run") - def test_update_config(self, run, wt, mkdir, rm): - rm.return_value = mock_rm = MagicMock() - mock_rm.get_latest_runner_bin_url = mock_get_latest_runner_bin_url - mock_rm.download_latest_runner_image = mock_download_latest_runner_image - - harness = Harness(GithubRunnerCharm) - harness.update_config({PATH_CONFIG_NAME: "mockorg/repo", TOKEN_CONFIG_NAME: "mocktoken"}) - harness.begin() - - # update to 0 virtual machines - harness.update_config({VIRTUAL_MACHINES_CONFIG_NAME: 0}) - harness.charm.on.reconcile_runners.emit() - token = harness.charm.service_token - state = harness.charm._setup_state() - rm.assert_called_with( - "github-runner", - "0", - LXDRunnerManagerConfig( - path=GitHubRepo(owner="mockorg", repo="repo"), - token="mocktoken", - image="jammy", - service_token=token, - lxd_storage_path=GithubRunnerCharm.juju_storage_path, - charm_state=state, - ), - ) - mock_rm.reconcile.assert_called_with(0, VirtualMachineResources(2, "7GiB", "10GiB")), - mock_rm.reset_mock() - - # update to 10 VMs with 4 cpu and 7GiB memory - harness.update_config( - {VIRTUAL_MACHINES_CONFIG_NAME: 5, VM_CPU_CONFIG_NAME: 4, VM_DISK_CONFIG_NAME: "6GiB"} - ) - harness.charm.on.reconcile_runners.emit() - token = harness.charm.service_token - state = harness.charm._setup_state() - rm.assert_called_with( - "github-runner", - "0", - LXDRunnerManagerConfig( - path=GitHubRepo(owner="mockorg", repo="repo"), - token="mocktoken", - image="jammy", - service_token=token, - lxd_storage_path=GithubRunnerCharm.juju_storage_path, - charm_state=state, - ), - ) - mock_rm.reconcile.assert_called_with( - 5, VirtualMachineResources(cpu=4, memory="7GiB", disk="6GiB") - ) - mock_rm.reset_mock() - - @patch("charm.LXDRunnerManager") @patch("pathlib.Path.mkdir") @patch("pathlib.Path.write_text") @patch("subprocess.run") - def test_on_update_status(self, run, wt, mkdir, rm): + def test_on_update_status(self, run, wt, mkdir): """ arrange: reconciliation event timer mocked to be \ 1. active. \ @@ -702,10 +397,6 @@ def test_on_update_status(self, run, wt, mkdir, rm): 2. ensure_event_timer is called. 3. Charm throws error. """ - rm.return_value = mock_rm = MagicMock() - mock_rm.get_latest_runner_bin_url = mock_get_latest_runner_bin_url - mock_rm.download_latest_runner_image = mock_download_latest_runner_image - harness = Harness(GithubRunnerCharm) harness.update_config({PATH_CONFIG_NAME: "mockorg/repo", TOKEN_CONFIG_NAME: "mocktoken"}) @@ -731,41 +422,11 @@ def test_on_update_status(self, run, wt, mkdir, rm): with pytest.raises(TimerEnableError): harness.charm.on.update_status.emit() - @patch("charm.LXDRunnerManager") - @patch("pathlib.Path.mkdir") - @patch("pathlib.Path.write_text") - @patch("subprocess.run") - def test_on_stop(self, run, wt, mkdir, rm): - rm.return_value = mock_rm = MagicMock() - harness = Harness(GithubRunnerCharm) - harness.update_config({PATH_CONFIG_NAME: "mockorg/repo", TOKEN_CONFIG_NAME: "mocktoken"}) - harness.begin() - harness.charm.on.stop.emit() - mock_rm.flush.assert_called() - - @patch("charm.LXDRunnerManager") - @patch("pathlib.Path.mkdir") - @patch("pathlib.Path.write_text") - @patch("subprocess.run") - def test_on_start_failure(self, run, wt, mkdir, rm): - """Test various error thrown during install.""" - rm.return_value = mock_rm = MagicMock() - mock_rm.get_latest_runner_bin_url = mock_get_latest_runner_bin_url - - harness = Harness(GithubRunnerCharm) - harness.update_config({PATH_CONFIG_NAME: "mockorg/repo", TOKEN_CONFIG_NAME: "mocktoken"}) - harness.begin() - - harness.charm._reconcile_lxd_runners = raise_runner_error - harness.charm.on.start.emit() - assert harness.charm.unit.status == ActiveStatus("Failed to start runners: mock error") - - @patch("charm.LXDRunnerManager") @patch("charm.RunnerScaler") @patch("pathlib.Path.mkdir") @patch("pathlib.Path.write_text") @patch("subprocess.run") - def test_on_config_changed_openstack_clouds_yaml(self, run, wt, mkdir, orm, rm): + def test_on_config_changed_openstack_clouds_yaml(self, run, wt, mkdir, orm): """ arrange: Setup mocked charm. act: Fire config changed event to use openstack-clouds-yaml. @@ -801,30 +462,10 @@ def test_on_config_changed_openstack_clouds_yaml(self, run, wt, mkdir, orm, rm): assert harness.charm.unit.status == BlockedStatus("Please provide image integration.") - @patch("charm.LXDRunnerManager") - @patch("pathlib.Path.mkdir") - @patch("pathlib.Path.write_text") - @patch("subprocess.run") - def test_check_runners_action(self, run, wt, mkdir, rm): - rm.return_value = mock_rm = MagicMock() - mock_event = MagicMock() - - mock_rm.get_github_info = mock_get_github_info - - harness = Harness(GithubRunnerCharm) - harness.update_config({PATH_CONFIG_NAME: "mockorg/repo", TOKEN_CONFIG_NAME: "mocktoken"}) - harness.begin() - - harness.charm._on_check_runners_action(mock_event) - mock_event.set_results.assert_called_with( - {"online": 2, "offline": 2, "unknown": 1, "runners": "test runner 0, test runner 1"} - ) - - @patch("charm.LXDRunnerManager") @patch("pathlib.Path.mkdir") @patch("pathlib.Path.write_text") @patch("subprocess.run") - def test_check_runners_action_with_errors(self, run, wt, mkdir, rm): + def test_check_runners_action_with_errors(self, run, wt, mkdir): mock_event = MagicMock() harness = Harness(GithubRunnerCharm) @@ -834,32 +475,12 @@ def test_check_runners_action_with_errors(self, run, wt, mkdir, rm): harness.charm._on_check_runners_action(mock_event) mock_event.fail.assert_called_with("Invalid Github config, Missing path configuration") - @patch("charm.LXDRunnerManager") - @patch("pathlib.Path.mkdir") - @patch("pathlib.Path.write_text") - @patch("subprocess.run") - def test_on_flush_runners_action(self, run, wt, mkdir, rm): - mock_event = MagicMock() - - harness = Harness(GithubRunnerCharm) - harness.begin() - - harness.charm._on_flush_runners_action(mock_event) - mock_event.fail.assert_called_with("Invalid Github config, Missing path configuration") - mock_event.reset_mock() - - harness.update_config({PATH_CONFIG_NAME: "mockorg/repo", TOKEN_CONFIG_NAME: "mocktoken"}) - harness.charm._on_flush_runners_action(mock_event) - mock_event.set_results.assert_called() - mock_event.reset_mock() - @pytest.mark.parametrize( "exception, expected_status", [ pytest.param(ConfigurationError, BlockedStatus, id="charm config error"), pytest.param(TokenError, BlockedStatus, id="github token error"), - pytest.param(MissingRunnerBinaryError, MaintenanceStatus, id="runner binary error"), ], ) def test_catch_charm_errors( @@ -901,7 +522,6 @@ def test_event_handler(self, _: typing.Any): "exception, expected_status", [ pytest.param(ConfigurationError, BlockedStatus, id="charm config error"), - pytest.param(MissingRunnerBinaryError, MaintenanceStatus, id="runner binary error"), ], ) def test_catch_action_errors( @@ -976,32 +596,6 @@ def test_openstack_image_ready_status( assert is_ready == expected_value -@pytest.mark.parametrize( - "hook", - [ - pytest.param("_on_image_relation_changed", id="image relation changed"), - pytest.param("_on_image_relation_joined", id="image relation joined"), - ], -) -def test__on_image_relation_hooks_not_openstack(hook: str): - """ - arrange: given a hook that is for OpenStack mode but the image relation exists. - act: when the hook is triggered. - assert: the charm falls into BlockedStatus. - """ - harness = Harness(GithubRunnerCharm) - harness.begin() - state_mock = MagicMock() - state_mock.instance_type = InstanceType.LOCAL_LXD - harness.charm._setup_state = MagicMock(return_value=state_mock) - - getattr(harness.charm, hook)(MagicMock()) - - assert harness.charm.unit.status == BlockedStatus( - "Openstack mode not enabled. Please remove the image integration." - ) - - def test__on_image_relation_image_not_ready(): """ arrange: given a charm with OpenStack instance type and a monkeypatched \ @@ -1012,7 +606,6 @@ def test__on_image_relation_image_not_ready(): harness = Harness(GithubRunnerCharm) harness.begin() state_mock = MagicMock() - state_mock.instance_type = InstanceType.OPENSTACK harness.charm._setup_state = MagicMock(return_value=state_mock) harness.charm._get_set_image_ready_status = MagicMock(return_value=False) @@ -1032,7 +625,6 @@ def test__on_image_relation_image_ready(): harness = Harness(GithubRunnerCharm) harness.begin() state_mock = MagicMock() - state_mock.instance_type = InstanceType.OPENSTACK harness.charm._setup_state = MagicMock(return_value=state_mock) harness.charm._get_set_image_ready_status = MagicMock(return_value=True) runner_manager_mock = MagicMock() @@ -1056,7 +648,6 @@ def test__on_image_relation_joined(): harness.add_relation_unit(relation_id, "image-builder/0") harness.begin() state_mock = MagicMock() - state_mock.instance_type = InstanceType.OPENSTACK state_mock.charm_config.openstack_clouds_yaml = OpenStackCloudsYAML( clouds={ "test-cloud": { diff --git a/tests/unit/test_charm_state.py b/tests/unit/test_charm_state.py index f3d3564f7..f29c47a3a 100644 --- a/tests/unit/test_charm_state.py +++ b/tests/unit/test_charm_state.py @@ -4,8 +4,6 @@ import logging import platform import secrets -import typing -from pathlib import Path from unittest.mock import MagicMock import pytest @@ -18,9 +16,7 @@ import charm_state from charm_state import ( - BASE_IMAGE_CONFIG_NAME, DEBUG_SSH_INTEGRATION_NAME, - DENYLIST_CONFIG_NAME, DOCKERHUB_MIRROR_CONFIG_NAME, GROUP_CONFIG_NAME, IMAGE_INTEGRATION_NAME, @@ -28,30 +24,18 @@ OPENSTACK_CLOUDS_YAML_CONFIG_NAME, PATH_CONFIG_NAME, RECONCILE_INTERVAL_CONFIG_NAME, - RUNNER_STORAGE_CONFIG_NAME, TOKEN_CONFIG_NAME, USE_APROXY_CONFIG_NAME, - VIRTUAL_MACHINES_CONFIG_NAME, - VM_CPU_CONFIG_NAME, - VM_DISK_CONFIG_NAME, - VM_MEMORY_CONFIG_NAME, Arch, - BaseImage, CharmConfig, CharmConfigInvalidError, CharmState, - FirewallEntry, GithubConfig, - ImmutableConfigChangedError, - LocalLxdRunnerConfig, OpenstackImage, OpenstackRunnerConfig, ProxyConfig, - ReactiveConfig, - RunnerStorage, SSHDebugConnection, UnsupportedArchitectureError, - VirtualMachineResources, ) from errors import MissingMongoDBError from tests.unit.factories import MockGithubRunnerCharmFactory @@ -220,35 +204,6 @@ def test_parse_labels(labels, expected_valid_labels): assert result == expected_valid_labels -@pytest.mark.parametrize( - "denylist_config, expected_entries", - [ - ("", []), - ("192.168.1.1", [FirewallEntry(ip_range="192.168.1.1")]), - ( - "192.168.1.1, 192.168.1.2, 192.168.1.3", - [ - FirewallEntry(ip_range="192.168.1.1"), - FirewallEntry(ip_range="192.168.1.2"), - FirewallEntry(ip_range="192.168.1.3"), - ], - ), - ], -) -def test_parse_denylist(denylist_config: str, expected_entries: typing.List[FirewallEntry]): - """ - arrange: Create a mock CharmBase instance with provided denylist configuration. - act: Call _parse_denylist method with the mock CharmBase instance. - assert: Verify that the method returns the expected list of FirewallEntry objects. - """ - mock_charm = MockGithubRunnerCharmFactory() - mock_charm.config[DENYLIST_CONFIG_NAME] = denylist_config - - result = CharmConfig._parse_denylist(mock_charm) - - assert result == expected_entries - - def test_parse_dockerhub_mirror_invalid_scheme(): """ arrange: Create a mock CharmBase instance with an invalid DockerHub mirror configuration. @@ -321,14 +276,13 @@ def test_parse_openstack_clouds_config_empty(): """ arrange: Create a mock CharmBase instance with an empty OpenStack clouds YAML config. act: Call _parse_openstack_clouds_config method with the mock CharmBase instance. - assert: Verify that the method returns None. + assert: Verify that the method raises CharmConfigInvalidError """ mock_charm = MockGithubRunnerCharmFactory() mock_charm.config[OPENSTACK_CLOUDS_YAML_CONFIG_NAME] = "" - result = CharmConfig._parse_openstack_clouds_config(mock_charm) - - assert result is None + with pytest.raises(CharmConfigInvalidError): + CharmConfig._parse_openstack_clouds_config(mock_charm) def test_parse_openstack_clouds_config_invalid_yaml(invalid_yaml_config: str): @@ -452,7 +406,6 @@ def test_charm_config_from_charm_valid(): mock_charm.config = { PATH_CONFIG_NAME: "owner/repo", RECONCILE_INTERVAL_CONFIG_NAME: "5", - DENYLIST_CONFIG_NAME: "192.168.1.1,192.168.1.2", DOCKERHUB_MIRROR_CONFIG_NAME: "https://example.com", # "clouds: { openstack: { auth: { username: 'admin' }}}" OPENSTACK_CLOUDS_YAML_CONFIG_NAME: yaml.safe_dump( @@ -482,70 +435,12 @@ def test_charm_config_from_charm_valid(): assert result.path == GitHubRepo(owner="owner", repo="repo") assert result.reconcile_interval == 5 - assert result.denylist == [ - FirewallEntry(ip_range="192.168.1.1"), - FirewallEntry(ip_range="192.168.1.2"), - ] assert result.dockerhub_mirror == "https://example.com" assert result.openstack_clouds_yaml == test_openstack_config assert result.labels == ("label1", "label2", "label3") assert result.token == "abc123" -@pytest.mark.parametrize( - "base_image, expected_str", - [ - (BaseImage.JAMMY, "jammy"), - (BaseImage.NOBLE, "noble"), - ], -) -def test_base_image_str_parametrized(base_image, expected_str): - """ - Parametrized test case for __str__ method of BaseImage enum. - - arrange: Pass BaseImage enum values and expected string. - act: Call __str__ method on each enum value. - assert: Ensure the returned string matches the expected string. - """ - assert str(base_image) == expected_str - - -def test_base_image_from_charm_invalid_image(): - """ - arrange: Create a mock CharmBase instance with an invalid base image configuration. - act: Call from_charm method with the mock CharmBase instance. - assert: Verify that the method raises an error. - """ - mock_charm = MockGithubRunnerCharmFactory() - mock_charm.config[BASE_IMAGE_CONFIG_NAME] = "invalid" - - with pytest.raises(ValueError): - BaseImage.from_charm(mock_charm) - - -@pytest.mark.parametrize( - "image_name, expected_result", - [ - ("noble", BaseImage.NOBLE), # Valid custom configuration "noble" - ("24.04", BaseImage.NOBLE), # Valid custom configuration "noble" - ("jammy", BaseImage.JAMMY), # Valid custom configuration "jammy" - ("22.04", BaseImage.JAMMY), # Valid custom configuration "jammy" - ], -) -def test_base_image_from_charm(image_name: str, expected_result: BaseImage): - """ - arrange: Create a mock CharmBase instance with the provided image_name configuration. - act: Call from_charm method with the mock CharmBase instance. - assert: Verify that the method returns the expected base image tag. - """ - mock_charm = MockGithubRunnerCharmFactory() - mock_charm.config[BASE_IMAGE_CONFIG_NAME] = image_name - - result = BaseImage.from_charm(mock_charm) - - assert result == expected_result - - def test_openstack_image_from_charm_no_connections(): """ arrange: Mock CharmBase instance without relation. @@ -607,181 +502,6 @@ def test_openstack_image_from_charm(): assert image.tags == test_tags -@pytest.mark.parametrize("virtual_machines", [(-1), (-5)]) # Invalid value # Invalid value -def test_check_virtual_machines_invalid(virtual_machines): - """ - arrange: Provide an invalid virtual machines value. - act: Call check_virtual_machines method with the provided value. - assert: Verify that the method raises ValueError with the correct message. - """ - with pytest.raises(ValueError) as exc_info: - LocalLxdRunnerConfig.check_virtual_machines(virtual_machines) - assert ( - str(exc_info.value) - == "The virtual-machines configuration needs to be greater or equal to 0" - ) - - -@pytest.mark.parametrize( - "virtual_machines", [(0), (5), (10)] # Minimum valid value # Valid value # Valid value -) -def test_check_virtual_machines_valid(virtual_machines): - """ - arrange: Provide a valid virtual machines value. - act: Call check_virtual_machines method with the provided value. - assert: Verify that the method returns the same value. - """ - result = LocalLxdRunnerConfig.check_virtual_machines(virtual_machines) - - assert result == virtual_machines - - -@pytest.mark.parametrize( - "vm_resources", - [ - VirtualMachineResources(cpu=0, memory="1GiB", disk="10GiB"), # Invalid CPU value - VirtualMachineResources(cpu=1, memory="invalid", disk="10GiB"), # Invalid memory value - VirtualMachineResources(cpu=1, memory="1GiB", disk="invalid"), # Invalid disk value - ], -) -def test_check_virtual_machine_resources_invalid(vm_resources): - """ - arrange: Provide an invalid virtual_machine_resources value. - act: Call check_virtual_machine_resources method with the provided value. - assert: Verify that the method raises ValueError. - """ - with pytest.raises(ValueError): - LocalLxdRunnerConfig.check_virtual_machine_resources(vm_resources) - - -@pytest.mark.parametrize( - "vm_resources, expected_result", - [ - ( - VirtualMachineResources(cpu=1, memory="1GiB", disk="10GiB"), - VirtualMachineResources(cpu=1, memory="1GiB", disk="10GiB"), - ), # Valid configuration - ( - VirtualMachineResources(cpu=2, memory="2GiB", disk="20GiB"), - VirtualMachineResources(cpu=2, memory="2GiB", disk="20GiB"), - ), # Valid configuration - ], -) -def test_check_virtual_machine_resources_valid(vm_resources, expected_result): - """ - arrange: Provide a valid virtual_machine_resources value. - act: Call check_virtual_machine_resources method with the provided value. - assert: Verify that the method returns the same value. - """ - result = LocalLxdRunnerConfig.check_virtual_machine_resources(vm_resources) - - assert result == expected_result - - -def test_runner_charm_config_from_charm_invalid_base_image(): - """ - arrange: Create a mock CharmBase instance with an invalid base image configuration. - act: Call from_charm method with the mock CharmBase instance. - assert: Verify that the method raises CharmConfigInvalidError with the correct message. - """ - mock_charm = MockGithubRunnerCharmFactory() - mock_charm.config[BASE_IMAGE_CONFIG_NAME] = "invalid" - - with pytest.raises(CharmConfigInvalidError) as exc_info: - LocalLxdRunnerConfig.from_charm(mock_charm) - assert str(exc_info.value) == "Invalid base image" - - -def test_runner_charm_config_from_charm_invalid_storage_config(): - """ - arrange: Create a mock CharmBase instance with an invalid storage configuration. - act: Call from_charm method with the mock CharmBase instance. - assert: Verify that the method raises CharmConfigInvalidError with the correct message. - """ - mock_charm = MockGithubRunnerCharmFactory() - mock_charm.config = { - BASE_IMAGE_CONFIG_NAME: "jammy", - RUNNER_STORAGE_CONFIG_NAME: "invalid", - VIRTUAL_MACHINES_CONFIG_NAME: "5", - VM_CPU_CONFIG_NAME: "2", - VM_MEMORY_CONFIG_NAME: "4GiB", - VM_DISK_CONFIG_NAME: "20GiB", - } - - with pytest.raises(CharmConfigInvalidError) as exc_info: - LocalLxdRunnerConfig.from_charm(mock_charm) - assert "Invalid runner-storage config" in str(exc_info.value) - - -def test_runner_charm_config_from_charm_invalid_cpu_config(): - """ - arrange: Create a mock CharmBase instance with an invalid cpu configuration. - act: Call from_charm method with the mock CharmBase instance. - assert: Verify that the method raises CharmConfigInvalidError with the correct message. - """ - mock_charm = MockGithubRunnerCharmFactory() - mock_charm.config = { - BASE_IMAGE_CONFIG_NAME: "jammy", - RUNNER_STORAGE_CONFIG_NAME: "memory", - VIRTUAL_MACHINES_CONFIG_NAME: "5", - VM_CPU_CONFIG_NAME: "invalid", - VM_MEMORY_CONFIG_NAME: "4GiB", - VM_DISK_CONFIG_NAME: "20GiB", - } - - with pytest.raises(CharmConfigInvalidError) as exc_info: - LocalLxdRunnerConfig.from_charm(mock_charm) - assert str(exc_info.value) == "Invalid vm-cpu configuration" - - -def test_runner_charm_config_from_charm_invalid_virtual_machines_config(): - """ - arrange: Create a mock CharmBase instance with an invalid virtual machines configuration. - act: Call from_charm method with the mock CharmBase instance. - assert: Verify that the method raises CharmConfigInvalidError with the correct message. - """ - mock_charm = MockGithubRunnerCharmFactory() - mock_charm.config = { - BASE_IMAGE_CONFIG_NAME: "jammy", - RUNNER_STORAGE_CONFIG_NAME: "memory", - VIRTUAL_MACHINES_CONFIG_NAME: "invalid", - VM_CPU_CONFIG_NAME: "2", - VM_MEMORY_CONFIG_NAME: "4GiB", - VM_DISK_CONFIG_NAME: "20GiB", - } - - with pytest.raises(CharmConfigInvalidError) as exc_info: - LocalLxdRunnerConfig.from_charm(mock_charm) - assert str(exc_info.value) == "The virtual-machines configuration must be int" - - -def test_runner_charm_config_from_charm_valid(): - """ - arrange: Create a mock CharmBase instance with valid configuration. - act: Call from_charm method with the mock CharmBase instance. - assert: Verify that the method returns a LocalLxdRunnerConfig instance with the expected - values. - """ - mock_charm = MockGithubRunnerCharmFactory() - mock_charm.config = { - BASE_IMAGE_CONFIG_NAME: "jammy", - RUNNER_STORAGE_CONFIG_NAME: "memory", - VIRTUAL_MACHINES_CONFIG_NAME: "5", - VM_CPU_CONFIG_NAME: "2", - VM_MEMORY_CONFIG_NAME: "4GiB", - VM_DISK_CONFIG_NAME: "20GiB", - } - - result = LocalLxdRunnerConfig.from_charm(mock_charm) - - assert result.base_image == BaseImage.JAMMY - assert result.runner_storage == RunnerStorage("memory") - assert result.virtual_machines == 5 - assert result.virtual_machine_resources == VirtualMachineResources( - cpu=2, memory="4GiB", disk="20GiB" - ) - - @pytest.mark.parametrize( "http, https, use_aproxy, expected_address", [ @@ -1059,130 +779,17 @@ def mock_charm_state_data(): "arch": "x86_64", "is_metrics_logging_available": True, "proxy_config": {"http": "http://example.com", "https": "https://example.com"}, - "charm_config": {"denylist": ["192.168.1.1"], "token": secrets.token_hex(16)}, + "charm_config": {"token": secrets.token_hex(16)}, "reactive_config": {"uri": "mongodb://user:password@localhost:27017"}, "runner_config": { - "base_image": "jammy", "virtual_machines": 2, - "runner_storage": "memory", }, - "instance_type": "local-lxd", "ssh_debug_connections": [ {"host": "10.1.2.4", "port": 22}, ], } -@pytest.mark.parametrize( - "immutable_config", - [ - pytest.param("runner_storage", id="Runner storage"), - pytest.param("base_image", id="Base image"), - ], -) -def test_check_immutable_config_key_error( - mock_charm_state_path: Path, - mock_charm_state_data: dict[str, typing.Any], - immutable_config: str, - monkeypatch: pytest.MonkeyPatch, - caplog: pytest.LogCaptureFixture, -): - """ - arrange: Mock CHARM_STATE_PATH and read_text method to return modified immutable config values. - act: Call _check_immutable_config_change method. - assert: None is returned. - """ - mock_charm_state_data["runner_config"].pop(immutable_config) - monkeypatch.setattr(charm_state, "CHARM_STATE_PATH", mock_charm_state_path) - monkeypatch.setattr( - charm_state.CHARM_STATE_PATH, - "read_text", - MagicMock(return_value=json.dumps(mock_charm_state_data)), - ) - - assert CharmState._check_immutable_config_change(RunnerStorage.MEMORY, BaseImage.JAMMY) is None - assert any( - f"Key {immutable_config} not found, this will be updated to current config." in message - for message in caplog.messages - ) - - -def test_check_immutable_config_change_no_previous_state( - mock_charm_state_path: Path, mock_charm_state_data: dict, monkeypatch: pytest.MonkeyPatch -): - """ - arrange: Mock CHARM_STATE_PATH and read_text method to return no previous state. - act: Call _check_immutable_config_change method. - assert: Ensure no exception is raised. - """ - monkeypatch.setattr(charm_state, "CHARM_STATE_PATH", mock_charm_state_path) - monkeypatch.setattr(charm_state.CHARM_STATE_PATH, "exists", MagicMock(return_value=False)) - state = CharmState(**mock_charm_state_data) - - assert state._check_immutable_config_change("new_runner_storage", "new_base_image") is None - - -def test_check_immutable_config_change_storage_changed( - mock_charm_state_path: Path, mock_charm_state_data: dict, monkeypatch: pytest.MonkeyPatch -): - """ - arrange: Mock CHARM_STATE_PATH and read_text method to return previous state with different \ - storage. - act: Call _check_immutable_config_change method. - assert: Ensure ImmutableConfigChangedError is raised. - """ - monkeypatch.setattr(charm_state, "CHARM_STATE_PATH", mock_charm_state_path) - monkeypatch.setattr( - charm_state.CHARM_STATE_PATH, - "read_text", - MagicMock(return_value=json.dumps(mock_charm_state_data)), - ) - state = CharmState(**mock_charm_state_data) - - with pytest.raises(ImmutableConfigChangedError): - state._check_immutable_config_change(RunnerStorage.JUJU_STORAGE, BaseImage.JAMMY) - - -def test_check_immutable_config_change_base_image_changed( - mock_charm_state_path, mock_charm_state_data, monkeypatch: pytest.MonkeyPatch -): - """ - arrange: Mock CHARM_STATE_PATH and read_text method to return previous state with different \ - base image. - act: Call _check_immutable_config_change method. - assert: Ensure ImmutableConfigChangedError is raised. - """ - monkeypatch.setattr(charm_state, "CHARM_STATE_PATH", mock_charm_state_path) - monkeypatch.setattr( - charm_state.CHARM_STATE_PATH, - "read_text", - MagicMock(return_value=json.dumps(mock_charm_state_data)), - ) - state = CharmState(**mock_charm_state_data) - - with pytest.raises(ImmutableConfigChangedError): - state._check_immutable_config_change(RunnerStorage.MEMORY, BaseImage.NOBLE) - - -def test_check_immutable_config( - mock_charm_state_path, mock_charm_state_data, monkeypatch: pytest.MonkeyPatch -): - """ - arrange: Mock CHARM_STATE_PATH and read_text method to return previous state with same config. - act: Call _check_immutable_config_change method. - assert: None is returned. - """ - monkeypatch.setattr(charm_state, "CHARM_STATE_PATH", mock_charm_state_path) - monkeypatch.setattr( - charm_state.CHARM_STATE_PATH, - "read_text", - MagicMock(return_value=json.dumps(mock_charm_state_data)), - ) - state = CharmState(**mock_charm_state_data) - - assert state._check_immutable_config_change(RunnerStorage.MEMORY, BaseImage.JAMMY) is None - - class MockModel(BaseModel): """A Mock model class used for pydantic error testing.""" @@ -1196,11 +803,6 @@ class MockModel(BaseModel): ValidationError([], MockModel), ), (ProxyConfig, "from_charm", ValueError), - ( - CharmState, - "_check_immutable_config_change", - ImmutableConfigChangedError("Immutable config changed"), - ), (CharmConfig, "from_charm", ValidationError([], MockModel)), (CharmConfig, "from_charm", ValueError), (charm_state, "_get_supported_arch", UnsupportedArchitectureError(arch="testarch")), @@ -1224,7 +826,6 @@ def test_charm_state_from_charm_invalid_cases( mock_charm_config_from_charm.return_value = mock_charm_config monkeypatch.setattr(CharmConfig, "from_charm", mock_charm_config_from_charm) monkeypatch.setattr(OpenstackRunnerConfig, "from_charm", MagicMock()) - monkeypatch.setattr(LocalLxdRunnerConfig, "from_charm", MagicMock()) monkeypatch.setattr(charm_state, "_get_supported_arch", MagicMock()) monkeypatch.setattr(SSHDebugConnection, "from_charm", MagicMock()) monkeypatch.setattr(module, target, MagicMock(side_effect=exc)) @@ -1244,8 +845,6 @@ def test_charm_state_from_charm(monkeypatch: pytest.MonkeyPatch): monkeypatch.setattr(ProxyConfig, "from_charm", MagicMock()) monkeypatch.setattr(CharmConfig, "from_charm", MagicMock()) monkeypatch.setattr(OpenstackRunnerConfig, "from_charm", MagicMock()) - monkeypatch.setattr(LocalLxdRunnerConfig, "from_charm", MagicMock()) - monkeypatch.setattr(CharmState, "_check_immutable_config_change", MagicMock()) monkeypatch.setattr(charm_state, "_get_supported_arch", MagicMock()) monkeypatch.setattr(charm_state, "ReactiveConfig", MagicMock()) monkeypatch.setattr(SSHDebugConnection, "from_charm", MagicMock()) @@ -1269,38 +868,3 @@ def test_charm_state__log_prev_state_redacts_sensitive_information( assert mock_charm_state_data["charm_config"]["token"] not in caplog.text assert charm_state.SENSITIVE_PLACEHOLDER in caplog.text - - -def test_charm_state_from_charm_reactive_with_lxd_raises_error(monkeypatch: pytest.MonkeyPatch): - """ - arrange: Mock CharmBase and necessary methods to enable reactive config and lxd storage. - act: Call CharmState.from_charm. - assert: Ensure an error is raised - """ - mock_charm = MockGithubRunnerCharmFactory() - mock_database = MagicMock(spec=DatabaseRequires) - - monkeypatch.setattr( - ReactiveConfig, - "from_database", - MagicMock(return_value=ReactiveConfig(mq_uri="mongodb://localhost:27017")), - ) - charm_config_mock = MagicMock() - charm_config_mock.openstack_clouds_yaml = None - monkeypatch.setattr(CharmConfig, "from_charm", MagicMock(return_value=charm_config_mock)) - - # mock all other required methods - monkeypatch.setattr(ProxyConfig, "from_charm", MagicMock()) - monkeypatch.setattr(OpenstackRunnerConfig, "from_charm", MagicMock()) - monkeypatch.setattr(LocalLxdRunnerConfig, "from_charm", MagicMock()) - monkeypatch.setattr(CharmState, "_check_immutable_config_change", MagicMock()) - monkeypatch.setattr(charm_state, "_get_supported_arch", MagicMock()) - monkeypatch.setattr(SSHDebugConnection, "from_charm", MagicMock()) - monkeypatch.setattr(json, "loads", MagicMock()) - monkeypatch.setattr(json, "dumps", MagicMock()) - monkeypatch.setattr(charm_state, "CHARM_STATE_PATH", MagicMock()) - - with pytest.raises(CharmConfigInvalidError) as exc: - CharmState.from_charm(mock_charm, mock_database) - - assert "Reactive mode not supported for local LXD instances" in str(exc.value) diff --git a/tests/unit/test_firewall.py b/tests/unit/test_firewall.py deleted file mode 100644 index 917c0bde4..000000000 --- a/tests/unit/test_firewall.py +++ /dev/null @@ -1,160 +0,0 @@ -# Copyright 2024 Canonical Ltd. -# See LICENSE file for licensing details. - -"""Test cases for firewall module.""" - -from ipaddress import IPv4Network - -import pytest - -from firewall import Firewall - - -@pytest.mark.parametrize( - "domain_ranges, exclude_ranges, expected", - [ - pytest.param([], [], [], id="empty domain[no exclude]"), - pytest.param([], (IPv4Network("127.0.0.1/32")), [], id="empty domain[one ip exclude]"), - pytest.param( - [], - [IPv4Network("127.0.0.1/32"), IPv4Network("127.0.0.2/32")], - [], - id="empty domain[multiple ips exclude]", - ), - pytest.param( - [IPv4Network("127.0.0.1/32")], - [IPv4Network("127.0.0.2/32")], - [IPv4Network("127.0.0.1/32")], - id="single ip single exclude ip[no overlap]", - ), - pytest.param( - [IPv4Network("127.0.0.1/32")], - [IPv4Network("127.0.0.1/32")], - [], - id="single ip single exclude ip[overlap]", - ), - pytest.param( - [IPv4Network("127.0.0.0/30")], - [IPv4Network("127.0.0.2/32")], - [IPv4Network("127.0.0.0/31"), IPv4Network("127.0.0.3/32")], - id="single domain single exclude ip[overlap single ip]", - ), - pytest.param( - [IPv4Network("127.0.0.0/28")], # 127.0.0.0-14 - [IPv4Network("127.0.0.1/32"), IPv4Network("127.0.1.1/32")], - [ - IPv4Network("127.0.0.0/32"), # 127.0.0.0 - IPv4Network("127.0.0.2/31"), # 127.0.0.2-3 - IPv4Network("127.0.0.4/30"), # 127.0.0.4-7 - IPv4Network("127.0.0.8/29"), # 127.0.0.8-14 - ], - id="single domain multiple exclude ips[overlap partial ips]", - ), - pytest.param( - [IPv4Network("127.0.0.0/30")], # 127.0.0.0-3 - [ - IPv4Network("127.0.0.0/32"), - IPv4Network("127.0.0.1/32"), - IPv4Network("127.0.0.2/32"), - IPv4Network("127.0.0.3/32"), - ], - [], - id="single domain multiple exclude ips[overlap all ips]", - ), - pytest.param( - [IPv4Network("127.0.0.0/30")], - [IPv4Network("127.0.1.0/30")], - [IPv4Network("127.0.0.0/30")], - id="single domain single exclude domain[no overlap]", - ), - pytest.param( - [IPv4Network("127.0.0.0/28")], # 127.0.0.0-15 - [IPv4Network("127.0.0.0/30")], # 127.0.0.0-4 - [ - IPv4Network("127.0.0.8/29"), # 127.0.0.8-15 - IPv4Network("127.0.0.4/30"), # 127.0.0.5-7 - ], - id="single domain single exclude domain[overlap partial range]", - ), - pytest.param( - [IPv4Network("127.0.0.0/30")], - [IPv4Network("127.0.0.0/30")], - [], - id="single domain single exclude domain[overlap full range]", - ), - pytest.param( - [IPv4Network("127.0.0.0/30"), IPv4Network("127.0.1.0/30")], - [IPv4Network("127.0.2.0/30")], - [IPv4Network("127.0.0.0/30"), IPv4Network("127.0.1.0/30")], - id="multiple domain single exclude domain[no overlap]", - ), - pytest.param( - [IPv4Network("127.0.0.0/28"), IPv4Network("127.0.1.0/28")], - [IPv4Network("127.0.0.0/30")], - [ - IPv4Network("127.0.0.8/29"), # 127.0.0.8-15 - IPv4Network("127.0.0.4/30"), # 127.0.0.5-7 - IPv4Network("127.0.1.0/28"), - ], - id="multiple domain single exclude domain[partial overlap]", - ), - pytest.param( - [IPv4Network("127.0.0.0/30"), IPv4Network("127.0.1.0/30")], - [IPv4Network("127.0.1.0/30")], - [IPv4Network("127.0.0.0/30")], - id="multiple domain single exclude domain[full overlap(equivalent network)]", - ), - pytest.param( - [IPv4Network("127.0.0.0/30"), IPv4Network("127.0.1.0/30")], - [IPv4Network("127.0.0.0/8")], - [], - id="multiple domain single exclude domain[full overlap(bigger network)]", - ), - pytest.param( - [IPv4Network("127.0.0.0/30"), IPv4Network("127.0.1.0/30")], - [IPv4Network("127.0.2.0/30"), IPv4Network("127.0.3.0/30")], - [IPv4Network("127.0.0.0/30"), IPv4Network("127.0.1.0/30")], - id="multiple domain multiple exclude domain[no overlaps]", - ), - pytest.param( - [IPv4Network("127.0.0.0/28"), IPv4Network("127.0.1.0/28")], - [IPv4Network("127.0.0.0/30"), IPv4Network("127.0.1.0/30")], - [ - IPv4Network("127.0.0.4/30"), # 127.0.0.5-7 - IPv4Network("127.0.0.8/29"), # 127.0.0.8-15 - IPv4Network("127.0.1.4/30"), # 127.0.1.5-7 - IPv4Network("127.0.1.8/29"), # 127.0.1.8-15 - ], - id="multiple domain multiple exclude domain[multiple partial overlaps]", - ), - pytest.param( - [IPv4Network("127.0.0.0/30"), IPv4Network("127.0.1.0/30")], - [IPv4Network("127.0.0.0/30"), IPv4Network("127.0.1.0/30")], - [], - id=( - "multiple domain multiple exclude domain[multiple full " - "overlaps(equivalent network)]" - ), - ), - pytest.param( - [IPv4Network("127.0.0.0/30"), IPv4Network("127.0.1.0/30")], - [IPv4Network("127.0.0.0/8")], - [], - id="multiple domain multiple exclude domain[multiple full overlaps(bigger network)]", - ), - ], -) -def test__exclude_network( - domain_ranges: list[IPv4Network], - exclude_ranges: list[IPv4Network], - expected: list[IPv4Network], -): - """ - arrange: given domain networks and some IPs to exclude from the domains. - act: when _exclude_network is called. - assert: new ip networks are returned with excluded target IP ranges. - """ - result = Firewall("test")._exclude_network(domain_ranges, exclude_ranges) - assert all(net in result for net in expected) and all( - net in expected for net in result - ), f"Difference in networks found, expected: {expected}, got: {result}." diff --git a/tests/unit/test_lxd_runner_manager.py b/tests/unit/test_lxd_runner_manager.py deleted file mode 100644 index b55757622..000000000 --- a/tests/unit/test_lxd_runner_manager.py +++ /dev/null @@ -1,568 +0,0 @@ -# Copyright 2024 Canonical Ltd. -# See LICENSE file for licensing details. - -"""Test cases of LXDRunnerManager class.""" -import random -import secrets -from pathlib import Path -from unittest.mock import MagicMock, call - -import github_runner_manager.reactive.runner_manager -import pytest -from github_runner_manager.metrics.events import ( - Reconciliation, - RunnerInstalled, - RunnerStart, - RunnerStop, -) -from github_runner_manager.metrics.runner import RUNNER_INSTALLED_TS_FILE_NAME -from github_runner_manager.metrics.storage import MetricsStorage -from github_runner_manager.types_.github import GitHubOrg, GitHubRepo, RunnerApplication -from pytest import MonkeyPatch - -import shared_fs -from charm_state import Arch, CharmConfig, CharmState, ProxyConfig, VirtualMachineResources -from errors import IssueMetricEventError, RunnerBinaryError -from runner import Runner, RunnerStatus -from runner_manager import BUILD_IMAGE_SCRIPT_FILENAME, LXDRunnerManager, LXDRunnerManagerConfig -from runner_type import RunnerNameByHealth -from tests.unit.mock import TEST_BINARY, MockLxdImageManager - -FAKE_MONGODB_URI = "mongodb://example.com/db" - -IMAGE_NAME = "jammy" - -RUNNER_MANAGER_TIME_MODULE = "runner_manager.time.time" -TEST_PROXY_SERVER_URL = "http://proxy.server:1234" - - -@pytest.fixture(scope="function", name="token") -def token_fixture(): - return secrets.token_hex() - - -@pytest.fixture(scope="function", name="charm_config") -def charm_config_fixture(): - """Mock charm config instance.""" - mock_charm_config = MagicMock(spec=CharmConfig) - mock_charm_config.labels = ("test",) - return mock_charm_config - - -@pytest.fixture(scope="function", name="charm_state") -def charm_state_fixture(charm_config: MagicMock): - mock = MagicMock(spec=CharmState) - mock.is_metrics_logging_available = False - mock.arch = Arch.X64 - mock.ssh_debug_connections = None - mock.charm_config = charm_config - return mock - - -@pytest.fixture( - scope="function", - name="runner_manager", - params=[ - (GitHubOrg("test_org", "test_group"), ProxyConfig()), - ( - GitHubRepo("test_owner", "test_repo"), - ProxyConfig( - no_proxy="test_no_proxy", - http=TEST_PROXY_SERVER_URL, - https=TEST_PROXY_SERVER_URL, - use_aproxy=False, - ), - ), - ], -) -def runner_manager_fixture(request, tmp_path, monkeypatch, token, charm_state): - charm_state.proxy_config = request.param[1] - monkeypatch.setattr( - "runner_manager.LXDRunnerManager.runner_bin_path", tmp_path / "mock_runner_binary" - ) - pool_path = tmp_path / "test_storage" - pool_path.mkdir(exist_ok=True) - - runner_manager = LXDRunnerManager( - "test app", - "0", - LXDRunnerManagerConfig( - path=request.param[0], - token=token, - image=IMAGE_NAME, - service_token=secrets.token_hex(16), - lxd_storage_path=pool_path, - charm_state=charm_state, - ), - ) - runner_manager.runner_bin_path.write_bytes(TEST_BINARY) - return runner_manager - - -@pytest.fixture(autouse=True, name="issue_event_mock") -def issue_event_mock_fixture(monkeypatch: MonkeyPatch) -> MagicMock: - """Mock the issue_event function.""" - issue_event_mock = MagicMock() - monkeypatch.setattr("github_runner_manager.metrics.events.issue_event", issue_event_mock) - return issue_event_mock - - -@pytest.fixture(autouse=True, name="shared_fs") -def shared_fs_fixture(tmp_path: Path, monkeypatch: MonkeyPatch) -> MagicMock: - """Mock the shared filesystem module.""" - shared_fs_mock = MagicMock(spec=shared_fs) - monkeypatch.setattr("runner_manager.shared_fs", shared_fs_mock) - monkeypatch.setattr("runner.shared_fs", shared_fs_mock) - return shared_fs_mock - - -@pytest.fixture(autouse=True, name="runner_metrics") -def runner_metrics_fixture(monkeypatch: MonkeyPatch) -> MagicMock: - """Mock the runner metrics module.""" - runner_metrics_mock = MagicMock() - monkeypatch.setattr("runner_manager.runner_metrics", runner_metrics_mock) - return runner_metrics_mock - - -@pytest.fixture(name="reactive_reconcile_mock") -def reactive_reconcile_fixture(monkeypatch: MonkeyPatch, tmp_path: Path) -> MagicMock: - """Mock the job class.""" - reconcile_mock = MagicMock(spec=github_runner_manager.reactive.runner_manager.reconcile) - monkeypatch.setattr("runner_manager.reactive_runner_manager.reconcile", reconcile_mock) - reconcile_mock.side_effect = lambda quantity, **kwargs: quantity - return reconcile_mock - - -@pytest.mark.parametrize( - "arch", - [ - pytest.param(Arch.ARM64), - pytest.param(Arch.X64), - ], -) -def test_get_latest_runner_bin_url(runner_manager: LXDRunnerManager, arch: Arch, charm_state): - """ - arrange: Nothing. - act: Get runner bin url of existing binary. - assert: Correct mock data returned. - """ - charm_state.arch = arch - mock_gh_client = MagicMock() - app = RunnerApplication( - os="linux", - architecture=arch.value, - download_url=(download_url := "https://www.example.com"), - filename=(filename := "test_runner_binary"), - ) - mock_gh_client.get_runner_application.return_value = app - runner_manager._clients.github = mock_gh_client - - runner_bin = runner_manager.get_latest_runner_bin_url(os_name="linux") - assert runner_bin["os"] == "linux" - assert runner_bin["architecture"] == arch.value - assert runner_bin["download_url"] == download_url - assert runner_bin["filename"] == filename - - -def test_get_latest_runner_bin_url_missing_binary(runner_manager: LXDRunnerManager): - """ - arrange: Given a mocked GH API client that does not return any runner binaries. - act: Get runner bin url of non-existing binary. - assert: Error related to runner bin raised. - """ - runner_manager._clients.github = MagicMock() - runner_manager._clients.github.get_runner_application.side_effect = RunnerBinaryError - - with pytest.raises(RunnerBinaryError): - runner_manager.get_latest_runner_bin_url(os_name="not_exist") - - -def test_update_runner_bin(runner_manager: LXDRunnerManager): - """ - arrange: Remove the existing runner binary. - act: Update runner binary. - assert: Runner binary in runner manager is set. - """ - - class MockRequestLibResponse: - """A mock requests library response.""" - - def __init__(self, *args, **kwargs): - """Initialize successful requests library response. - - Args: - args: Placeholder for positional arguments. - kwargs: Placeholder for keyword arguments. - """ - self.status_code = 200 - - def iter_content(self, *args, **kwargs): - """Mock content iterator returning an iterator over a single test runner binary. - - Args: - args: Placeholder positional arguments. - kwargs: Placeholder keyword arguments. - - Returns: - An iterator over a single test runner binary. - """ - return iter([TEST_BINARY]) - - runner_manager.runner_bin_path.unlink(missing_ok=True) - - runner_manager.session.get = MockRequestLibResponse - runner_bin = runner_manager.get_latest_runner_bin_url(os_name="linux") - - runner_manager.update_runner_bin(runner_bin) - - assert runner_manager.runner_bin_path.read_bytes() == TEST_BINARY - - -def test_reconcile_zero_count(runner_manager: LXDRunnerManager): - """ - arrange: Nothing. - act: Reconcile with the current amount of runner. - assert: No error should be raised. - """ - # Reconcile with no change to runner count. - delta = runner_manager.reconcile(0, VirtualMachineResources(2, "7GiB", "10Gib")) - - assert delta == 0 - - -def test_reconcile_create_runner(runner_manager: LXDRunnerManager): - """ - arrange: Nothing. - act: Reconcile to create a runner. - assert: One runner should be created. - """ - # Create a runner. - delta = runner_manager.reconcile(1, VirtualMachineResources(2, "7GiB", "10Gib")) - - assert delta == 1 - - -def test_reconcile_remove_runner(runner_manager: LXDRunnerManager): - """ - arrange: Create online runners. - act: Reconcile to remove a runner. - assert: One runner should be removed. - """ - - def mock_get_runners(): - """Create three mock runners. - - Returns: - Three mock runners. - """ - runners = [] - for _ in range(3): - # 0 is a mock runner id. - status = RunnerStatus(0, True, True, False) - runners.append(Runner(MagicMock(), MagicMock(), status, None)) - return runners - - # Create online runners. - runner_manager._get_runners = mock_get_runners - runner_manager._get_runner_health_states = lambda: RunnerNameByHealth( - ( - f"{runner_manager.instance_name}-0", - f"{runner_manager.instance_name}-1", - f"{runner_manager.instance_name}-2", - ), - (), - ) - - delta = runner_manager.reconcile(2, VirtualMachineResources(2, "7GiB", "10Gib")) - - assert delta == -1 - - -def test_reconcile(runner_manager: LXDRunnerManager, tmp_path: Path): - """ - arrange: Setup one runner. - act: Reconcile with the current amount of runner. - assert: Still have one runner. - """ - runner_manager.reconcile(1, VirtualMachineResources(2, "7GiB", "10Gib")) - # Reconcile with no change to runner count. - runner_manager.reconcile(1, VirtualMachineResources(2, "7GiB", "10Gib")) - - assert len(runner_manager._get_runners()) == 1 - - -def test_empty_flush(runner_manager: LXDRunnerManager): - """ - arrange: No initial runners. - act: Perform flushing with no runners. - assert: No error thrown. - """ - # Verifying the RunnerManager does not crash if flushing with no runners. - runner_manager.flush() - - -def test_flush(runner_manager: LXDRunnerManager, tmp_path: Path): - """ - arrange: Create some runners. - act: Perform flushing. - assert: No runners. - """ - # Create a runner. - runner_manager.reconcile(2, VirtualMachineResources(2, "7GiB", "10Gib")) - - runner_manager.flush() - assert len(runner_manager._get_runners()) == 0 - - -def test_reconcile_issues_runner_installed_event( - runner_manager: LXDRunnerManager, - monkeypatch: MonkeyPatch, - issue_event_mock: MagicMock, - charm_state: MagicMock, -): - """ - arrange: Enable issuing of metrics and mock timestamps. - act: Reconcile to create a runner. - assert: The expected event is issued. - """ - charm_state.is_metrics_logging_available = True - t_mock = MagicMock(return_value=12345) - monkeypatch.setattr(RUNNER_MANAGER_TIME_MODULE, t_mock) - - runner_manager.reconcile(1, VirtualMachineResources(2, "7GiB", "10Gib")) - - issue_event_mock.assert_has_calls( - [call(event=RunnerInstalled(timestamp=12345, flavor=runner_manager.app_name, duration=0))] - ) - - -def test_reconcile_issues_no_runner_installed_event_if_metrics_disabled( - runner_manager: LXDRunnerManager, issue_event_mock: MagicMock, charm_state: MagicMock -): - """ - arrange: Disable issuing of metrics. - act: Reconcile to create a runner. - assert: The expected event is not issued. - """ - charm_state.is_metrics_logging_available = False - - runner_manager.reconcile(1, VirtualMachineResources(2, "7GiB", "10Gib")) - - issue_event_mock.assert_not_called() - - -def test_reconcile_error_on_issue_event_is_ignored( - runner_manager: LXDRunnerManager, - issue_event_mock: MagicMock, - charm_state: MagicMock, -): - """ - arrange: Enable issuing of metrics and mock the metric issuing to raise an expected error. - act: Reconcile. - assert: No error is raised. - """ - charm_state.is_metrics_logging_available = True - - issue_event_mock.side_effect = IssueMetricEventError("test error") - - delta = runner_manager.reconcile(1, VirtualMachineResources(2, "7GiB", "10Gib")) - - assert delta == 1 - - -def test_reconcile_issues_reconciliation_metric_event( - runner_manager: LXDRunnerManager, - monkeypatch: MonkeyPatch, - issue_event_mock: MagicMock, - runner_metrics: MagicMock, - charm_state: MagicMock, -): - """ - arrange: \ - - Enable issuing of metrics \ - - Mock timestamps \ - - Mock the result of runner_metrics.issue_event to contain 2 RunnerStart and 1 RunnerStop \ - events, meaning one runner was active and one crashed. \ - - Create two online runners , one active and one idle. - act: Reconcile. - assert: The expected event is issued. We expect two idle runners and one crashed runner - to be reported. - """ - charm_state.is_metrics_logging_available = True - t_mock = MagicMock(return_value=12345) - monkeypatch.setattr(RUNNER_MANAGER_TIME_MODULE, t_mock) - runner_metrics.extract.return_value = (MagicMock() for _ in range(2)) - runner_metrics.issue_events.side_effect = [{RunnerStart, RunnerStop}, {RunnerStart}] - - online_idle_runner_name = f"{runner_manager.instance_name}-0" - offline_idle_runner_name = f"{runner_manager.instance_name}-1" - active_runner_name = f"{runner_manager.instance_name}-2" - - def mock_get_runners(): - """Create three mock runners where one is busy. - - Returns: - Mock runners with one busy runner. - """ - runners = [] - - online_idle_runner = RunnerStatus(runner_id=0, exist=True, online=True, busy=False) - offline_idle_runner = RunnerStatus(runner_id=1, exist=True, online=False, busy=False) - active_runner = RunnerStatus(runner_id=2, exist=True, online=True, busy=True) - - for runner_status, runner_config in zip( - (online_idle_runner, offline_idle_runner, active_runner), - (online_idle_runner_name, offline_idle_runner_name, active_runner_name), - ): - config = MagicMock() - config.name = runner_config - runners.append( - Runner( - clients=MagicMock(), - runner_config=config, - runner_status=runner_status, - instance=None, - ) - ) - - return runners - - # Create online runners. - runner_manager._get_runners = mock_get_runners - runner_manager._get_runner_health_states = lambda: RunnerNameByHealth( - healthy=( - online_idle_runner_name, - offline_idle_runner_name, - active_runner_name, - ), - unhealthy=(), - ) - - quantity = random.randint(0, 5) - runner_manager.reconcile( - quantity=quantity, resources=VirtualMachineResources(2, "7GiB", "10Gib") - ) - - issue_event_mock.assert_any_call( - event=Reconciliation( - timestamp=12345, - flavor=runner_manager.app_name, - crashed_runners=1, - idle_runners=2, - active_runners=1, - expected_runners=quantity, - duration=0, - ) - ) - - -def test_reconcile_places_timestamp_in_newly_created_runner( - runner_manager: LXDRunnerManager, - monkeypatch: MonkeyPatch, - shared_fs: MagicMock, - tmp_path: Path, - charm_state: MagicMock, -): - """ - arrange: Enable issuing of metrics, mock timestamps and create the directory for the shared\ - filesystem. - act: Reconcile to create a runner. - assert: The expected timestamp is placed in the shared filesystem. - """ - charm_state.is_metrics_logging_available = True - t_mock = MagicMock(return_value=12345) - monkeypatch.setattr(RUNNER_MANAGER_TIME_MODULE, t_mock) - runner_shared_fs = tmp_path / "runner_fs" - runner_shared_fs.mkdir() - fs = MetricsStorage(path=runner_shared_fs, runner_name="test_runner") - shared_fs.get.return_value = fs - - runner_manager.reconcile(1, VirtualMachineResources(2, "7GiB", "10Gib")) - - assert (fs.path / RUNNER_INSTALLED_TS_FILE_NAME).exists() - assert (fs.path / RUNNER_INSTALLED_TS_FILE_NAME).read_text() == "12345" - - -def test_reconcile_error_on_placing_timestamp_is_ignored( - runner_manager: LXDRunnerManager, shared_fs: MagicMock, tmp_path: Path, charm_state: MagicMock -): - """ - arrange: Enable issuing of metrics and do not create the directory for the shared filesystem\ - in order to let a FileNotFoundError to be raised inside the RunnerManager. - act: Reconcile to create a runner. - assert: No exception is raised. - """ - charm_state.is_metrics_logging_available = True - runner_shared_fs = tmp_path / "runner_fs" - fs = MetricsStorage(path=runner_shared_fs, runner_name="test_runner") - shared_fs.get.return_value = fs - - runner_manager.reconcile(1, VirtualMachineResources(2, "7GiB", "10Gib")) - - assert not (fs.path / RUNNER_INSTALLED_TS_FILE_NAME).exists() - - -def test_reconcile_places_no_timestamp_in_newly_created_runner_if_metrics_disabled( - runner_manager: LXDRunnerManager, shared_fs: MagicMock, tmp_path: Path, charm_state: MagicMock -): - """ - arrange: Disable issuing of metrics, mock timestamps and the shared filesystem module. - act: Reconcile to create a runner. - assert: No timestamp is placed in the shared filesystem. - """ - charm_state.is_metrics_logging_available = False - - fs = MetricsStorage(path=tmp_path, runner_name="test_runner") - shared_fs.get.return_value = fs - - runner_manager.reconcile(1, VirtualMachineResources(2, "7GiB", "10Gib")) - - assert not (fs.path / RUNNER_INSTALLED_TS_FILE_NAME).exists() - - -def test_schedule_build_runner_image( - runner_manager: LXDRunnerManager, - tmp_path: Path, - charm_state: CharmState, - monkeypatch: MonkeyPatch, -): - """ - arrange: Mock the cron path and the randint function. - act: Schedule the build runner image. - assert: The cron file is created with the expected content. - """ - runner_manager.cron_path = tmp_path / "cron" - runner_manager.cron_path.mkdir() - monkeypatch.setattr(random, "randint", MagicMock(spec=random.randint, return_value=4)) - - runner_manager.schedule_build_runner_image() - - cronfile = runner_manager.cron_path / "build-runner-image" - http = charm_state.proxy_config.http or "''" - https = charm_state.proxy_config.https or "''" - no_proxy = charm_state.proxy_config.no_proxy or "''" - - cmd = f"/usr/bin/bash {BUILD_IMAGE_SCRIPT_FILENAME.absolute()} {http} {https} {no_proxy}" - - assert cronfile.exists() - assert cronfile.read_text() == f"4 4,10,16,22 * * * ubuntu {cmd} jammy\n" - - -def test_has_runner_image(runner_manager: LXDRunnerManager): - """ - arrange: Multiple setups. - 1. no runner image exists. - 2. runner image with wrong name exists. - 3. runner image with correct name exists. - act: Check if runner image exists. - assert: - 1 and 2. False is returned. - 3. True is returned. - """ - assert not runner_manager.has_runner_image() - - runner_manager._clients.lxd.images = MockLxdImageManager({"hirsute"}) - assert not runner_manager.has_runner_image() - - runner_manager._clients.lxd.images = MockLxdImageManager({IMAGE_NAME}) - assert runner_manager.has_runner_image() diff --git a/tests/unit/test_runner.py b/tests/unit/test_runner.py deleted file mode 100644 index e6d57f305..000000000 --- a/tests/unit/test_runner.py +++ /dev/null @@ -1,565 +0,0 @@ -# Copyright 2024 Canonical Ltd. -# See LICENSE file for licensing details. - -"""Test cases of Runner class.""" - -import secrets -import unittest -from pathlib import Path -from unittest.mock import MagicMock, call - -import github_runner_manager.metrics.runner_logs -import jinja2 -import pytest -from _pytest.monkeypatch import MonkeyPatch -from github_runner_manager.metrics.storage import MetricsStorage -from github_runner_manager.types_.github import GitHubOrg, GitHubRepo - -from charm_state import SSHDebugConnection, VirtualMachineResources -from errors import ( - CreateMetricsStorageError, - LxdError, - RunnerCreateError, - RunnerLogsError, - RunnerRemoveError, -) -from lxd import LxdInstance, LxdInstanceFileManager -from runner import DIAG_DIR_PATH, CreateRunnerConfig, Runner, RunnerConfig, RunnerStatus -from runner_manager_type import RunnerManagerClients -from runner_type import ProxySetting -from tests.unit.factories import SSHDebugInfoFactory -from tests.unit.mock import ( - MockLxdClient, - MockRepoPolicyComplianceClient, - mock_lxd_error_func, - mock_runner_error_func, -) - -TEST_PROXY_SERVER_URL = "http://proxy.server:1234" - - -@pytest.fixture(scope="module", name="vm_resources") -def vm_resources_fixture(): - return VirtualMachineResources(2, "7Gib", "10Gib") - - -@pytest.fixture(scope="function", name="token") -def token_fixture(): - return secrets.token_hex() - - -@pytest.fixture(scope="function", name="binary_path") -def binary_path_fixture(tmp_path: Path): - return tmp_path / "test_binary" - - -@pytest.fixture(scope="module", name="instance", params=["Running", "Stopped", None]) -def instance_fixture(request): - if request.param[0] is None: - return None - - attrs = {"status": request.param[0], "execute.return_value": (0, "", "")} - instance = unittest.mock.MagicMock(**attrs) - return instance - - -@pytest.fixture(scope="function", name="lxd") -def mock_lxd_client_fixture(): - return MockLxdClient() - - -@pytest.fixture(autouse=True, scope="function", name="shared_fs") -def shared_fs_fixture(monkeypatch: MonkeyPatch) -> MagicMock: - """Mock the module for handling the Shared Filesystem.""" - mock = MagicMock() - monkeypatch.setattr("runner.shared_fs", mock) - return mock - - -@pytest.fixture(autouse=True, scope="function", name="exc_cmd_mock") -def exc_command_fixture(monkeypatch: MonkeyPatch) -> MagicMock: - """Mock the execution of a command.""" - exc_cmd_mock = MagicMock() - monkeypatch.setattr("runner.execute_command", exc_cmd_mock) - return exc_cmd_mock - - -@pytest.fixture(name="log_dir_base_path") -def log_dir_base_path_fixture(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Path: - """Mock the create_logs_dir function and return the base path of the log directory.""" - log_dir_base_path = tmp_path / "log_dir" - - def create_logs_dir(runner_name: str) -> Path: - """Create the directory to store the logs of the crashed runners. - - Args: - runner_name: The name of the runner. - - Returns: - The path to the directory where the logs of the crashed runners will be stored. - """ - target_log_path = log_dir_base_path / runner_name - target_log_path.mkdir(parents=True, exist_ok=True) - - return target_log_path - - create_logs_dir_mock = MagicMock( - spec=github_runner_manager.metrics.runner_logs.create_logs_dir - ) - create_logs_dir_mock.side_effect = create_logs_dir - monkeypatch.setattr("runner.create_logs_dir", create_logs_dir_mock) - - return log_dir_base_path - - -@pytest.fixture(scope="function", name="jinja") -def jinja2_environment_fixture() -> MagicMock: - """Mock the jinja2 environment. - - Provides distinct mocks for each template. - """ - jinja2_mock = MagicMock(spec=jinja2.Environment) - template_mocks = { - "start.j2": MagicMock(), - "pre-job.j2": MagicMock(), - "env.j2": MagicMock(), - "environment.j2": MagicMock(), - "systemd-docker-proxy.j2": MagicMock(), - } - jinja2_mock.get_template.side_effect = lambda x: template_mocks.get(x, MagicMock()) - return jinja2_mock - - -@pytest.fixture(scope="function", name="ssh_debug_connections") -def ssh_debug_connections_fixture() -> list[SSHDebugConnection]: - """A list of randomly generated ssh_debug_connections.""" - return SSHDebugInfoFactory.create_batch(size=100) - - -@pytest.fixture( - scope="function", - name="runner", - params=[ - ( - GitHubOrg("test_org", "test_group"), - ProxySetting(no_proxy=None, http=None, https=None, aproxy_address=None), - ), - ( - GitHubRepo("test_owner", "test_repo"), - ProxySetting( - no_proxy="test_no_proxy", - http=TEST_PROXY_SERVER_URL, - https=TEST_PROXY_SERVER_URL, - aproxy_address=None, - ), - ), - ], -) -def runner_fixture( - request, - lxd: MockLxdClient, - jinja: MagicMock, - tmp_path: Path, - ssh_debug_connections: list[SSHDebugConnection], -): - client = RunnerManagerClients( - MagicMock(), - jinja, - lxd, - MockRepoPolicyComplianceClient(), - ) - pool_path = tmp_path / "test_storage" - pool_path.mkdir(exist_ok=True) - config = RunnerConfig( - name="test_runner", - app_name="test_app", - path=request.param[0], - proxies=request.param[1], - lxd_storage_path=pool_path, - labels=("test", "label"), - dockerhub_mirror=None, - issue_metrics=False, - ssh_debug_connections=ssh_debug_connections, - ) - lxd_instance_mock = MagicMock(spec=LxdInstance) - lxd_instance_mock.files = MagicMock(LxdInstanceFileManager) - status = RunnerStatus() - return Runner(client, config, status, lxd_instance_mock) - - -def test_create( - runner: Runner, - vm_resources: VirtualMachineResources, - token: str, - binary_path: Path, - lxd: MockLxdClient, -): - """ - arrange: Nothing. - act: Create a runner. - assert: An lxd instance for the runner is created. - """ - runner.create( - config=CreateRunnerConfig( - image="test_image", - resources=vm_resources, - binary_path=binary_path, - registration_token=token, - ) - ) - - instances = lxd.instances.all() - assert len(instances) == 1 - - if runner.config.proxies: - instance = instances[0] - env_proxy = instance.files.read_file("/home/ubuntu/github-runner/.env") - systemd_docker_proxy = instance.files.read_file( - "/etc/systemd/system/docker.service.d/http-proxy.conf" - ) - # Test the file has being written to. This value does not contain the string as the - # jinja2.environment.Environment is mocked with MagicMock. - assert env_proxy is not None - assert systemd_docker_proxy is not None - - -def test_create_lxd_fail( - runner: Runner, - vm_resources: VirtualMachineResources, - token: str, - binary_path: Path, - lxd: MockLxdClient, - monkeypatch: pytest.MonkeyPatch, -): - """ - arrange: Setup the create runner to fail with lxd error. - act: Create a runner. - assert: Correct exception should be thrown. Any created instance should be - cleanup. - """ - monkeypatch.setattr(lxd.profiles, "exists", mock_lxd_error_func) - - with pytest.raises(RunnerCreateError): - runner.create( - config=CreateRunnerConfig( - image="test_image", - resources=vm_resources, - binary_path=binary_path, - registration_token=token, - ) - ) - - assert len(lxd.instances.all()) == 0 - - -def test_create_runner_fail( - runner: Runner, - vm_resources: VirtualMachineResources, - token: str, - binary_path: Path, - lxd: MockLxdClient, -): - """ - arrange: Setup the create runner to fail with runner error. - act: Create a runner. - assert: Correct exception should be thrown. Any created instance should be - cleanup. - """ - runner._clients.lxd.instances.create = mock_runner_error_func - - with pytest.raises(RunnerCreateError): - runner.create( - config=CreateRunnerConfig( - image="test_image", - resources=vm_resources, - binary_path=binary_path, - registration_token=token, - ) - ) - - -def test_create_with_metrics( - runner: Runner, - vm_resources: VirtualMachineResources, - token: str, - binary_path: Path, - lxd: MockLxdClient, - shared_fs: MagicMock, - exc_cmd_mock: MagicMock, - jinja: MagicMock, -): - """ - arrange: Config the runner to issue metrics and mock the shared filesystem. - act: Create a runner. - assert: The command for adding a device has been executed and the templates are - rendered to issue metrics. - """ - runner.config.issue_metrics = True - shared_fs.create.return_value = MetricsStorage( - path=Path("/home/ubuntu/shared_fs"), runner_name="test_runner" - ) - runner.create( - config=CreateRunnerConfig( - image="test_image", - resources=vm_resources, - binary_path=binary_path, - registration_token=token, - ) - ) - - exc_cmd_mock.assert_called_once_with( - [ - "sudo", - "lxc", - "config", - "device", - "add", - "test_runner", - "metrics", - "disk", - "source=/home/ubuntu/shared_fs", - "path=/metrics-exchange", - ], - check_exit=True, - ) - - jinja.get_template("start.j2").render.assert_called_once_with(issue_metrics=True) - jinja.get_template("pre-job.j2").render.assert_called_once() - assert "issue_metrics" in jinja.get_template("pre-job.j2").render.call_args[1] - - -def test_create_with_metrics_and_shared_fs_error( - runner: Runner, - vm_resources: VirtualMachineResources, - token: str, - binary_path: Path, - lxd: MockLxdClient, - shared_fs: MagicMock, -): - """ - arrange: Config the runner to issue metrics and mock the shared filesystem module\ - to throw an expected error. - act: Create a runner. - assert: The runner is created despite the error on the shared filesystem. - """ - runner.config.issue_metrics = True - shared_fs.create.side_effect = CreateMetricsStorageError("") - - runner.create( - config=CreateRunnerConfig( - image="test_image", - resources=vm_resources, - binary_path=binary_path, - registration_token=token, - ) - ) - - instances = lxd.instances.all() - assert len(instances) == 1 - - -def test_remove( - runner: Runner, - vm_resources: VirtualMachineResources, - token: str, - binary_path: Path, - lxd: MockLxdClient, -): - """ - arrange: Create a runner. - act: Remove the runner. - assert: The lxd instance for the runner is removed. - """ - runner.create( - config=CreateRunnerConfig( - image="test_image", - resources=vm_resources, - binary_path=binary_path, - registration_token=token, - ) - ) - runner.remove("test_token") - assert len(lxd.instances.all()) == 0 - - -def test_remove_failed_instance( - runner: Runner, - vm_resources: VirtualMachineResources, - token: str, - binary_path: Path, - lxd: MockLxdClient, -): - """ - arrange: Create a stopped runner that failed to remove itself. - act: Remove the runner. - assert: The lxd instance for the runner is removed. - """ - # Cases where the ephemeral instance encountered errors and the status was Stopped but not - # removed was found before. - runner.create( - config=CreateRunnerConfig( - image="test_image", - resources=vm_resources, - binary_path=binary_path, - registration_token=token, - ) - ) - runner.instance.status = "Stopped" - runner.remove("test_token") - assert len(lxd.instances.all()) == 0 - - -def test_remove_none( - runner: Runner, - token: str, - lxd: MockLxdClient, -): - """ - arrange: Not creating a runner. - act: Remove the runner. - assert: The lxd instance for the runner is removed. - """ - runner.remove(token) - assert len(lxd.instances.all()) == 0 - - -def test_remove_with_stop_error( - runner: Runner, - vm_resources: VirtualMachineResources, - token: str, - binary_path: Path, - lxd: MockLxdClient, -): - """ - arrange: Create a runner. Set up LXD stop fails with LxdError. - act: Remove the runner. - assert: RunnerRemoveError is raised. - """ - runner.create( - config=CreateRunnerConfig( - image="test_image", - resources=vm_resources, - binary_path=binary_path, - registration_token=token, - ) - ) - runner.instance.stop = mock_lxd_error_func - - with pytest.raises(RunnerRemoveError): - runner.remove("test_token") - - -def test_remove_with_delete_error( - runner: Runner, - vm_resources: VirtualMachineResources, - token: str, - binary_path: Path, - lxd: MockLxdClient, -): - """ - arrange: Create a runner. Set up LXD delete fails with LxdError. - act: Remove the runner. - assert: RunnerRemoveError is raised. - """ - runner.create( - config=CreateRunnerConfig( - image="test_image", - resources=vm_resources, - binary_path=binary_path, - registration_token=token, - ) - ) - runner.instance.status = "Stopped" - runner.instance.delete = mock_lxd_error_func - - with pytest.raises(RunnerRemoveError): - runner.remove("test_token") - - -def test_random_ssh_connection_choice( - runner: Runner, - vm_resources: VirtualMachineResources, - token: str, - binary_path: Path, -): - """ - arrange: given a mock runner with random batch of ssh debug infos. - act: when runner.configure_runner is called. - assert: selected ssh_debug_info is random. - """ - runner.create( - config=CreateRunnerConfig( - image="test_image", - resources=vm_resources, - binary_path=binary_path, - registration_token=token, - ) - ) - runner._configure_runner() - first_call_args = runner._clients.jinja.get_template("env.j2").render.call_args.kwargs - runner._configure_runner() - second_call_args = runner._clients.jinja.get_template("env.j2").render.call_args.kwargs - - assert first_call_args["ssh_debug_info"] != second_call_args["ssh_debug_info"], ( - "Same ssh debug info found, this may have occurred with a very low probability. " - "Just try again." - ) - - -def test_pull_logs(runner: Runner, log_dir_base_path: Path): - """ - arrange: Mock the Runner instance and the base log directory path. - act: Get the logs of the runner. - assert: The expected log directory is created and logs are pulled. - """ - runner.config.name = "test-runner" - runner.instance.files.pull_file = MagicMock() - - runner.pull_logs() - - assert log_dir_base_path.exists() - - log_dir_path = log_dir_base_path / "test-runner" - log_dir_base_path.exists() - - runner.instance.files.pull_file.assert_has_calls( - [ - call(str(DIAG_DIR_PATH), str(log_dir_path), is_dir=True), - call(str(github_runner_manager.metrics.runner_logs.SYSLOG_PATH), str(log_dir_path)), - ] - ) - - -@pytest.mark.usefixtures("log_dir_base_path") -def test_pull_logs_no_instance(runner: Runner): - """ - arrange: Mock the Runner instance to be None. - act: Get the logs of the runner. - assert: A RunnerLogsError is raised. - """ - runner.config.name = "test-runner" - runner.instance = None - - with pytest.raises(RunnerLogsError) as exc_info: - runner.pull_logs() - - assert "Cannot pull the logs for test-runner as runner has no running instance." in str( - exc_info.value - ) - - -@pytest.mark.usefixtures("log_dir_base_path") -def test_pull_logs_lxd_error(runner: Runner): - """ - arrange: Mock the Runner instance to raise an LxdError. - act: Get the logs of the runner. - assert: A RunnerLogsError is raised. - """ - runner.config.name = "test-runner" - runner.instance.files.pull_file = MagicMock(side_effect=LxdError("Cannot pull file")) - - with pytest.raises(RunnerLogsError) as exc_info: - runner.pull_logs() - - assert "Cannot pull the logs for test-runner." in str(exc_info.value) - assert "Cannot pull file" in str(exc_info.value.__cause__) diff --git a/tests/unit/test_shared_fs.py b/tests/unit/test_shared_fs.py deleted file mode 100644 index 12dc11506..000000000 --- a/tests/unit/test_shared_fs.py +++ /dev/null @@ -1,334 +0,0 @@ -# Copyright 2024 Canonical Ltd. -# See LICENSE file for licensing details. -import secrets -import shutil -from pathlib import Path -from unittest.mock import MagicMock, Mock - -import pytest -from _pytest.monkeypatch import MonkeyPatch -from github_runner_manager.metrics.storage import MetricsStorage - -import shared_fs -from errors import ( - CreateMetricsStorageError, - DeleteMetricsStorageError, - GetMetricsStorageError, - SubprocessError, -) - -MOUNTPOINT_FAILURE_EXIT_CODE = 1 - - -@pytest.fixture(autouse=True, name="filesystem_paths") -def filesystem_paths_fixture(monkeypatch: MonkeyPatch, tmp_path: Path) -> dict[str, Path]: - """Mock the hardcoded filesystem paths.""" - fs_path = tmp_path / "runner-fs" - fs_images_path = tmp_path / "images" - monkeypatch.setattr("shared_fs.FILESYSTEM_IMAGES_PATH", fs_images_path) - return {"base": fs_path, "images": fs_images_path} - - -@pytest.fixture(autouse=True, name="metrics_storage_mock") -def metrics_storage_fixture( - monkeypatch: MonkeyPatch, filesystem_paths: dict[str, Path] -) -> MagicMock: - """Mock the metrics storage.""" - metrics_storage_mock = MagicMock() - storage_manager_cls_mock = MagicMock(return_value=metrics_storage_mock) - monkeypatch.setattr(shared_fs.metrics_storage, "StorageManager", storage_manager_cls_mock) - fs_base_path = filesystem_paths["base"] - fs_base_path.mkdir() - - def create(runner_name: str) -> MetricsStorage: - """Create metrics storage for the runner. - - Args: - runner_name: The name of the runner. - - Raises: - CreateMetricsStorageError: If the creation of the metrics storage fails. - - Returns: - The metrics storage. - """ - if (fs_base_path / runner_name).exists(): - raise CreateMetricsStorageError("Filesystem already exists") - (fs_base_path / runner_name).mkdir() - return MetricsStorage(fs_base_path, runner_name) - - def list_all(): - """List all shared filesystems. - - Returns: - A generator of metrics storage objects. - """ - return ( - MetricsStorage(runner_dir, str(runner_dir.name)) - for runner_dir in fs_base_path.iterdir() - ) - - def get(runner_name: str) -> MetricsStorage: - """Get the metrics storage for the runner. - - Args: - runner_name: The name of the runner. - - Raises: - GetMetricsStorageError: If the filesystem is not found. - - Returns: - The metrics storage. - """ - if not (fs_base_path / runner_name).exists(): - raise GetMetricsStorageError("Filesystem not found") - return MetricsStorage(fs_base_path / runner_name, runner_name) - - metrics_storage_mock.create.side_effect = create - metrics_storage_mock.get.side_effect = get - metrics_storage_mock.list_all.side_effect = list_all - metrics_storage_mock.delete.side_effect = lambda runner_name: shutil.rmtree( - fs_base_path / runner_name - ) - - return metrics_storage_mock - - -@pytest.fixture(autouse=True, name="exc_cmd_mock") -def exc_command_fixture(monkeypatch: MonkeyPatch) -> Mock: - """Mock the execution of a command.""" - exc_cmd_mock = Mock(return_value=("", 0)) - monkeypatch.setattr("shared_fs.execute_command", exc_cmd_mock) - return exc_cmd_mock - - -def exc_cmd_side_effect(*args, **_): - """Mock command to return NOT_A_MOUNTPOINT exit code. - - Args: - args: Positional argument placeholder. - - Returns: - Fake exc_cmd return values. - """ - if args[0][0] == "mountpoint": - return "", shared_fs.DIR_NO_MOUNTPOINT_EXIT_CODE - return "", 0 - - -def test_create_creates_directory(): - """ - arrange: Given a runner name and a path for the filesystems. - act: Call create. - assert: The shared filesystem path is created. - """ - runner_name = secrets.token_hex(16) - - fs = shared_fs.create(runner_name) - - assert fs.path.exists() - assert fs.path.is_dir() - - -def test_create_raises_exception(exc_cmd_mock: MagicMock): - """ - arrange: Given a runner name and a mocked execute_command which raises an expected exception. - act: Call create. - assert: The expected exception is raised. - """ - runner_name = secrets.token_hex(16) - exc_cmd_mock.side_effect = SubprocessError( - cmd=["mock"], return_code=1, stdout="mock stdout", stderr="mock stderr" - ) - - with pytest.raises(CreateMetricsStorageError): - shared_fs.create(runner_name) - - -def test_create_raises_exception_if_already_exists(): - """ - arrange: Given a runner name and an already existing shared filesystem. - act: Call create. - assert: The expected exception is raised. - """ - runner_name = secrets.token_hex(16) - shared_fs.create(runner_name) - - with pytest.raises(CreateMetricsStorageError): - shared_fs.create(runner_name) - - -def test_list_shared_filesystems(): - """ - arrange: Create shared filesystems for multiple runners. - act: Call list. - assert: A generator listing all the shared filesystems is returned. - """ - runner_names = [secrets.token_hex(16) for _ in range(3)] - for runner_name in runner_names: - shared_fs.create(runner_name) - - fs_list = list(shared_fs.list_all()) - - assert len(fs_list) == 3 - for fs in fs_list: - assert isinstance(fs, MetricsStorage) - assert fs.runner_name in runner_names - - -def test_list_shared_filesystems_empty(): - """ - arrange: Nothing. - act: Call list. - assert: An empty generator is returned. - """ - fs_list = list(shared_fs.list_all()) - - assert len(fs_list) == 0 - - -def test_list_shared_filesystems_ignore_unmounted_fs(exc_cmd_mock: MagicMock): - """ - arrange: Create shared filesystems for multiple runners and mock mountpoint cmd \ - to return NOT_A_MOUNTPOINT exit code for a dedicated runner. - act: Call list. - assert: A generator listing all the shared filesystems except the one of the dedicated runner - is returned. - """ - runner_names = [secrets.token_hex(16) for _ in range(3)] - for runner_name in runner_names: - shared_fs.create(runner_name) - - runner_with_mount_failure = runner_names[0] - - def exc_cmd_side_effect(*args, **_): - """Mock command to return NOT_A_MOUNTPOINT exit code. - - Args: - args: Positional argument placeholder. - - Returns: - Fake exc_cmd return values. - """ - if args[0][0] == "mountpoint" and runner_with_mount_failure in args[0][2]: - return "", MOUNTPOINT_FAILURE_EXIT_CODE - return "", 0 - - exc_cmd_mock.side_effect = exc_cmd_side_effect - - fs_list = list(shared_fs.list_all()) - - assert len(fs_list) == 2 - assert runner_with_mount_failure not in [fs.runner_name for fs in fs_list] - - -def test_delete_filesystem(): - """ - arrange: Create a shared filesystem for a runner. - act: Call delete - assert: The shared filesystem is deleted. - """ - runner_name = secrets.token_hex(16) - shared_fs.create(runner_name) - - shared_fs.delete(runner_name) - - with pytest.raises(GetMetricsStorageError): - shared_fs.get(runner_name) - - -def test_delete_raises_error(): - """ - arrange: Nothing. - act: Call delete. - assert: A DeleteMetricsStorageError is raised. - """ - runner_name = secrets.token_hex(16) - - with pytest.raises(DeleteMetricsStorageError): - shared_fs.delete(runner_name) - - -def test_delete_filesystem_ignores_unmounted_filesystem(exc_cmd_mock: MagicMock): - """ - arrange: Create a shared filesystem for a runner and mock mountpoint cmd \ - to return NOT_A_MOUNTPOINT exit code. - act: Call delete. - assert: The shared filesystem is deleted. - """ - runner_name = secrets.token_hex(16) - shared_fs.create(runner_name) - - exc_cmd_mock.side_effect = exc_cmd_side_effect - - shared_fs.delete(runner_name) - - with pytest.raises(GetMetricsStorageError): - shared_fs.get(runner_name) - - -def test_get_shared_filesystem(): - """ - arrange: Given a runner name. - act: Call create and get. - assert: A metrics storage object for this runner is returned. - """ - runner_name = secrets.token_hex(16) - - shared_fs.create(runner_name) - fs = shared_fs.get(runner_name) - - assert isinstance(fs, MetricsStorage) - assert fs.runner_name == runner_name - - -def test_get_raises_error_if_not_found(): - """ - arrange: Nothing. - act: Call get. - assert: A GetMetricsStorageError is raised. - """ - runner_name = secrets.token_hex(16) - - with pytest.raises(GetMetricsStorageError): - shared_fs.get(runner_name) - - -def test_get_mounts_if_unmounted(filesystem_paths: dict[str, Path], exc_cmd_mock: MagicMock): - """ - arrange: Given a runner name and a mock mountpoint cmd which returns NOT_A_MOUNTPOINT \ - exit code. - act: Call create and get. - assert: The shared filesystem is mounted. - """ - runner_name = secrets.token_hex(16) - shared_fs.create(runner_name) - - exc_cmd_mock.side_effect = exc_cmd_side_effect - - shared_fs.get(runner_name) - - exc_cmd_mock.assert_any_call( - [ - "sudo", - "mount", - "-o", - "loop", - str(shared_fs._get_runner_image_path(runner_name)), - str(filesystem_paths["base"] / runner_name), - ], - check_exit=True, - ) - - -def test_move_to_quarantine(metrics_storage_mock: MagicMock): - """ - arrange: Given a runner name. - act: Call move_to_quarantine. - assert: The method is called on the metrics storage manager. - """ - runner_name = secrets.token_hex(16) - - shared_fs.move_to_quarantine(runner_name) - - metrics_storage_mock.move_to_quarantine.assert_called_once_with(runner_name) diff --git a/tox.ini b/tox.ini index f58f1cb86..181e4073a 100644 --- a/tox.ini +++ b/tox.ini @@ -9,9 +9,8 @@ envlist = lint, unit, static, coverage-report [vars] src_path = {toxinidir}/src/ tst_path = {toxinidir}/tests/ -scripts_path = {toxinidir}/scripts/ github_runner_manager_path = {toxinidir}/github-runner-manager/ -all_path = {[vars]src_path} {[vars]tst_path} {[vars]scripts_path} +all_path = {[vars]src_path} {[vars]tst_path} [testenv] @@ -72,8 +71,8 @@ commands = isort --check-only --diff {[vars]all_path} black --check --diff {[vars]all_path} mypy {[vars]all_path} - pylint {[vars]src_path} {[vars]scripts_path} - pydocstyle {[vars]src_path} {[vars]scripts_path} + pylint {[vars]src_path} + pydocstyle {[vars]src_path} [testenv:unit] description = Run unit tests