#!/usr/bin/env python3
# Copyright 2020 Canonical Ltd.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# For those usages not covered by the Apache License, Version 2.0 please
# contact: legal@canonical.com
#
# To get in touch with the maintainers, please contact:
# osm-charmers@lists.launchpad.net
##
from typing import NoReturn
import unittest
import pod_spec
class TestPodSpec(unittest.TestCase):
"""Pod spec unit tests."""
def test_make_pod_ports(self) -> NoReturn:
"""Testing make pod ports."""
port = 9090
expected_result = [
{
"name": "prometheus",
"containerPort": port,
"protocol": "TCP",
}
]
pod_ports = pod_spec._make_pod_ports(port)
self.assertListEqual(expected_result, pod_ports)
def test_make_pod_envconfig(self) -> NoReturn:
"""Testing make pod envconfig."""
config = {}
relation_state = {}
expected_result = {}
pod_envconfig = pod_spec._make_pod_envconfig(config, relation_state)
self.assertDictEqual(expected_result, pod_envconfig)
def test_make_pod_ingress_resources_without_site_url(self) -> NoReturn:
"""Testing make pod ingress resources without site_url."""
config = {"site_url": ""}
app_name = "prometheus"
port = 9090
pod_ingress_resources = pod_spec._make_pod_ingress_resources(
config, app_name, port
)
self.assertIsNone(pod_ingress_resources)
def test_make_pod_ingress_resources(self) -> NoReturn:
"""Testing make pod ingress resources."""
config = {
"site_url": "http://prometheus",
"max_file_size": 0,
"ingress_whitelist_source_range": "",
}
app_name = "prometheus"
port = 9090
expected_result = [
{
"name": f"{app_name}-ingress",
"annotations": {
"nginx.ingress.kubernetes.io/proxy-body-size": f"{config['max_file_size']}",
"nginx.ingress.kubernetes.io/ssl-redirect": "false",
},
"spec": {
"rules": [
{
"host": app_name,
"http": {
"paths": [
{
"path": "/",
"backend": {
"serviceName": app_name,
"servicePort": port,
},
}
]
},
}
]
},
}
]
pod_ingress_resources = pod_spec._make_pod_ingress_resources(
config, app_name, port
)
self.assertListEqual(expected_result, pod_ingress_resources)
def test_make_pod_ingress_resources_with_whitelist_source_range(self) -> NoReturn:
"""Testing make pod ingress resources with whitelist_source_range."""
config = {
"site_url": "http://prometheus",
"max_file_size": 0,
"ingress_whitelist_source_range": "0.0.0.0/0",
}
app_name = "prometheus"
port = 9090
expected_result = [
{
"name": f"{app_name}-ingress",
"annotations": {
"nginx.ingress.kubernetes.io/proxy-body-size": f"{config['max_file_size']}",
"nginx.ingress.kubernetes.io/ssl-redirect": "false",
"nginx.ingress.kubernetes.io/whitelist-source-range": config[
"ingress_whitelist_source_range"
],
},
"spec": {
"rules": [
{
"host": app_name,
"http": {
"paths": [
{
"path": "/",
"backend": {
"serviceName": app_name,
"servicePort": port,
},
}
]
},
}
]
},
}
]
pod_ingress_resources = pod_spec._make_pod_ingress_resources(
config, app_name, port
)
self.assertListEqual(expected_result, pod_ingress_resources)
def test_make_pod_ingress_resources_with_https(self) -> NoReturn:
"""Testing make pod ingress resources with HTTPs."""
config = {
"site_url": "https://prometheus",
"max_file_size": 0,
"ingress_whitelist_source_range": "",
"tls_secret_name": "",
}
app_name = "prometheus"
port = 9090
expected_result = [
{
"name": f"{app_name}-ingress",
"annotations": {
"nginx.ingress.kubernetes.io/proxy-body-size": f"{config['max_file_size']}",
},
"spec": {
"rules": [
{
"host": app_name,
"http": {
"paths": [
{
"path": "/",
"backend": {
"serviceName": app_name,
"servicePort": port,
},
}
]
},
}
],
"tls": [{"hosts": [app_name]}],
},
}
]
pod_ingress_resources = pod_spec._make_pod_ingress_resources(
config, app_name, port
)
self.assertListEqual(expected_result, pod_ingress_resources)
def test_make_pod_ingress_resources_with_https_tls_secret_name(self) -> NoReturn:
"""Testing make pod ingress resources with HTTPs and TLS secret name."""
config = {
"site_url": "https://prometheus",
"max_file_size": 0,
"ingress_whitelist_source_range": "",
"tls_secret_name": "secret_name",
}
app_name = "prometheus"
port = 9090
expected_result = [
{
"name": f"{app_name}-ingress",
"annotations": {
"nginx.ingress.kubernetes.io/proxy-body-size": f"{config['max_file_size']}",
},
"spec": {
"rules": [
{
"host": app_name,
"http": {
"paths": [
{
"path": "/",
"backend": {
"serviceName": app_name,
"servicePort": port,
},
}
]
},
}
],
"tls": [
{"hosts": [app_name], "secretName": config["tls_secret_name"]}
],
},
}
]
pod_ingress_resources = pod_spec._make_pod_ingress_resources(
config, app_name, port
)
self.assertListEqual(expected_result, pod_ingress_resources)
def test_make_pod_files(self) -> NoReturn:
"""Testing make pod files."""
config = {
"web_subpath": "/",
"default_target": "",
"site_url": "",
}
expected_result = [
{
"name": "config",
"mountPath": "/etc/prometheus",
"files": [
{
"path": "prometheus.yml",
"content": (
"global:\n"
" scrape_interval: 15s\n"
" evaluation_interval: 15s\n"
"alerting:\n"
" alertmanagers:\n"
" - static_configs:\n"
" - targets:\n"
"rule_files:\n"
"scrape_configs:\n"
" - job_name: 'prometheus'\n"
" static_configs:\n"
" - targets: [{}]\n".format(config["default_target"])
),
}
],
}
]
pod_envconfig = pod_spec._make_pod_files(config)
print(expected_result, pod_envconfig)
self.assertListEqual(expected_result, pod_envconfig)
def test_make_readiness_probe(self) -> NoReturn:
"""Testing make readiness probe."""
port = 9090
expected_result = {
"httpGet": {
"path": "/-/ready",
"port": port,
},
"initialDelaySeconds": 10,
"timeoutSeconds": 30,
}
readiness_probe = pod_spec._make_readiness_probe(port)
self.assertDictEqual(expected_result, readiness_probe)
def test_make_liveness_probe(self) -> NoReturn:
"""Testing make liveness probe."""
port = 9090
expected_result = {
"httpGet": {
"path": "/-/healthy",
"port": port,
},
"initialDelaySeconds": 30,
"periodSeconds": 30,
}
liveness_probe = pod_spec._make_liveness_probe(port)
self.assertDictEqual(expected_result, liveness_probe)
def test_make_pod_command(self) -> NoReturn:
"""Testing make pod command."""
port = 9090
config = {
"web_subpath": "/",
"default_target": "",
"site_url": "",
}
expected_result = [
"/bin/prometheus",
"--config.file=/etc/prometheus/prometheus.yml",
"--storage.tsdb.path=/prometheus",
"--web.console.libraries=/usr/share/prometheus/console_libraries",
"--web.console.templates=/usr/share/prometheus/consoles",
"--web.route-prefix={}".format(config.get("web_subpath")),
"--web.external-url=http://localhost:{}{}".format(
port, config.get("web_subpath")
),
]
pod_envconfig = pod_spec._make_pod_command(config, port)
self.assertListEqual(expected_result, pod_envconfig)
def test_make_pod_command_with_web_admin_api_enabled(self) -> NoReturn:
"""Testing make pod command."""
port = 9090
config = {
"web_subpath": "/",
"default_target": "",
"site_url": "",
"enable_web_admin_api": True,
}
expected_result = [
"/bin/prometheus",
"--config.file=/etc/prometheus/prometheus.yml",
"--storage.tsdb.path=/prometheus",
"--web.console.libraries=/usr/share/prometheus/console_libraries",
"--web.console.templates=/usr/share/prometheus/consoles",
"--web.route-prefix={}".format(config.get("web_subpath")),
"--web.external-url=http://localhost:{}{}".format(
port, config.get("web_subpath")
),
"--web.enable-admin-api",
]
pod_envconfig = pod_spec._make_pod_command(config, port)
self.assertListEqual(expected_result, pod_envconfig)
def test_make_pod_spec(self) -> NoReturn:
"""Testing make pod spec."""
image_info = {"upstream-source": "ubuntu/prometheus:latest"}
config = {
"web_subpath": "/",
"default_target": "",
"site_url": "",
"enable_web_admin_api": False,
}
relation_state = {}
app_name = "prometheus"
port = 9090
expected_result = {
"version": 3,
"containers": [
{
"name": app_name,
"imageDetails": image_info,
"imagePullPolicy": "Always",
"ports": [
{
"name": app_name,
"containerPort": port,
"protocol": "TCP",
}
],
"envConfig": {},
"volumeConfig": [
{
"name": "config",
"mountPath": "/etc/prometheus",
"files": [
{
"path": "prometheus.yml",
"content": (
"global:\n"
" scrape_interval: 15s\n"
" evaluation_interval: 15s\n"
"alerting:\n"
" alertmanagers:\n"
" - static_configs:\n"
" - targets:\n"
"rule_files:\n"
"scrape_configs:\n"
" - job_name: 'prometheus'\n"
" static_configs:\n"
" - targets: [{}]\n".format(
config.get("default_target")
)
),
}
],
}
],
"command": [
"/bin/prometheus",
"--config.file=/etc/prometheus/prometheus.yml",
"--storage.tsdb.path=/prometheus",
"--web.console.libraries=/usr/share/prometheus/console_libraries",
"--web.console.templates=/usr/share/prometheus/consoles",
"--web.route-prefix={}".format(config.get("web_subpath")),
"--web.external-url=http://localhost:{}{}".format(
port, config.get("web_subpath")
),
],
"kubernetes": {
"readinessProbe": {
"httpGet": {
"path": "/-/ready",
"port": port,
},
"initialDelaySeconds": 10,
"timeoutSeconds": 30,
},
"livenessProbe": {
"httpGet": {
"path": "/-/healthy",
"port": port,
},
"initialDelaySeconds": 30,
"periodSeconds": 30,
},
},
}
],
"kubernetesResources": {"ingressResources": []},
}
spec = pod_spec.make_pod_spec(
image_info, config, relation_state, app_name, port
)
self.assertDictEqual(expected_result, spec)
def test_make_pod_spec_with_ingress(self) -> NoReturn:
"""Testing make pod spec."""
image_info = {"upstream-source": "ubuntu/prometheus:latest"}
config = {
"web_subpath": "/",
"default_target": "",
"site_url": "https://prometheus",
"tls_secret_name": "prometheus",
"max_file_size": 0,
"ingress_whitelist_source_range": "0.0.0.0/0",
"enable_web_admin_api": False,
}
relation_state = {}
app_name = "prometheus"
port = 9090
expected_result = {
"version": 3,
"containers": [
{
"name": app_name,
"imageDetails": image_info,
"imagePullPolicy": "Always",
"ports": [
{
"name": app_name,
"containerPort": port,
"protocol": "TCP",
}
],
"envConfig": {},
"volumeConfig": [
{
"name": "config",
"mountPath": "/etc/prometheus",
"files": [
{
"path": "prometheus.yml",
"content": (
"global:\n"
" scrape_interval: 15s\n"
" evaluation_interval: 15s\n"
"alerting:\n"
" alertmanagers:\n"
" - static_configs:\n"
" - targets:\n"
"rule_files:\n"
"scrape_configs:\n"
" - job_name: 'prometheus'\n"
" static_configs:\n"
" - targets: [{}]\n".format(
config.get("default_target")
)
),
}
],
}
],
"command": [
"/bin/prometheus",
"--config.file=/etc/prometheus/prometheus.yml",
"--storage.tsdb.path=/prometheus",
"--web.console.libraries=/usr/share/prometheus/console_libraries",
"--web.console.templates=/usr/share/prometheus/consoles",
"--web.route-prefix={}".format(config.get("web_subpath")),
"--web.external-url=http://localhost:{}{}".format(
port, config.get("web_subpath")
),
],
"kubernetes": {
"readinessProbe": {
"httpGet": {
"path": "/-/ready",
"port": port,
},
"initialDelaySeconds": 10,
"timeoutSeconds": 30,
},
"livenessProbe": {
"httpGet": {
"path": "/-/healthy",
"port": port,
},
"initialDelaySeconds": 30,
"periodSeconds": 30,
},
},
}
],
"kubernetesResources": {
"ingressResources": [
{
"name": "{}-ingress".format(app_name),
"annotations": {
"nginx.ingress.kubernetes.io/proxy-body-size": str(
config.get("max_file_size")
),
"nginx.ingress.kubernetes.io/whitelist-source-range": config.get(
"ingress_whitelist_source_range"
),
},
"spec": {
"rules": [
{
"host": app_name,
"http": {
"paths": [
{
"path": "/",
"backend": {
"serviceName": app_name,
"servicePort": port,
},
}
]
},
}
],
"tls": [
{
"hosts": [app_name],
"secretName": config.get("tls_secret_name"),
}
],
},
}
],
},
}
spec = pod_spec.make_pod_spec(
image_info, config, relation_state, app_name, port
)
self.assertDictEqual(expected_result, spec)
def test_make_pod_spec_without_image_info(self) -> NoReturn:
"""Testing make pod spec without image_info."""
image_info = None
config = {
"web_subpath": "/",
"default_target": "",
"site_url": "",
"enable_web_admin_api": False,
}
relation_state = {}
app_name = "prometheus"
port = 9090
spec = pod_spec.make_pod_spec(
image_info, config, relation_state, app_name, port
)
self.assertIsNone(spec)
def test_make_pod_spec_without_config(self) -> NoReturn:
"""Testing make pod spec without config."""
image_info = {"upstream-source": "ubuntu/prometheus:latest"}
config = {}
relation_state = {}
app_name = "prometheus"
port = 9090
with self.assertRaises(ValueError):
pod_spec.make_pod_spec(image_info, config, relation_state, app_name, port)
if __name__ == "__main__":
unittest.main()