diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4cb9dd9..bde6a94 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -49,8 +49,6 @@ jobs: run: make test - name: Upload coverage to Codecov uses: codecov/codecov-action@v3 - - name: Selenium test - run: make selenium shellcheck: name: Shellcheck @@ -61,15 +59,3 @@ jobs: uses: ludeeus/action-shellcheck@master with: scandir: . - - docker: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - uses: docker/setup-buildx-action@v2 - - name: test docker image - run: | - docker compose -f examples/docker-compose.yml --project-directory . build --pull - PASS=testing docker compose -f examples/docker-compose.yml --project-directory . up -d - sleep 10 - test "$(curl -4k -u test:testing https://localhost:8443/test)" = "OK" diff --git a/Dockerfile b/Dockerfile index 66b6483..c3c8114 100644 --- a/Dockerfile +++ b/Dockerfile @@ -4,10 +4,7 @@ RUN zypper addrepo https://download.opensuse.org/repositories/SUSE:/CA/openSUSE_ zypper --gpg-auto-import-keys -n install ca-certificates-suse && \ zypper -n install \ python3-apache-libcloud \ - python3-cachetools \ python3-cryptography \ - python3-Jinja2 \ - python3-pyramid \ python3-python-dateutil \ python3-pytz \ python3-PyYAML && \ diff --git a/Makefile b/Makefile index 051bfb9..eaf869c 100644 --- a/Makefile +++ b/Makefile @@ -18,11 +18,7 @@ pylint: .PHONY: test test: - @SKIP_SELENIUM=1 TZ=Europe/Berlin pytest --capture=sys -v --cov --cov-report term-missing - -.PHONY: selenium -selenium: - @pytest tests/test_selenium.py + TZ=Europe/Berlin pytest --capture=sys -v --cov --cov-report term-missing .PHONY: mypy mypy: diff --git a/README.md b/README.md index e0403a4..6ecb812 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Docker image available at `ghcr.io/ricardobranco777/cloudview:latest` ## Usage ``` -usage: cloudview.py [-h] [-c CONFIG] [-f FORMAT] [-l {none,debug,info,warning,error,critical}] [-o {text,html,json}] [-p PORT] [-P {ec2,gce,azure_arm,openstack}] [-r] +usage: cloudview.py [-h] [-c CONFIG] [-f FORMAT] [-l {none,debug,info,warning,error,critical}] [-o {text,json}] [-P {ec2,gce,azure_arm,openstack}] [-r] [-s {name,state,time}] [-S {error,migrating,normal,paused,pending,rebooting,reconfiguring,running,starting,stopped,stopping,suspended,terminated,unknown,updating}] [-t TIME_FORMAT] [-v] [--version] @@ -25,9 +25,8 @@ options: output fields (default: provider,name,size,state,time,location) -l {none,debug,info,warning,error,critical}, --log {none,debug,info,warning,error,critical} logging level (default: error) - -o {text,html,json}, --output {text,html,json} + -o {text,json}, --output {text,json} output type (default: text) - -p PORT, --port PORT run a web server on specified port (default: None) -P {ec2,gce,azure_arm,openstack}, --providers {ec2,gce,azure_arm,openstack} list only specified providers (default: None) -r, --reverse reverse sort (default: False) @@ -59,16 +58,6 @@ NOTES: The [cloudview](scripts/cloudview) script scans `clouds.yaml` and environment variables to execute the proper `docker` command. -## To run the web server with Docker Compose: - -If you have a TLS key pair, put the certificates in `cert.pem`, the private key in `key.pem` and the file containing the passphrase to the private key in `key.txt`. Then edit the [docker-compose.yml](examples/docker-compose.yml) file to mount the directory to `/etc/nginx/ssl` in the container like this: `- "/path/to/tls:/etc/nginx/ssl:ro"`. Set and export the `NGINX_HOST` environment variable with the FQDN of your host. - -For HTTP Basic Authentication, create a file named `auth.htpasswd` in the same directory with the TLS key pair. - -If you don't have a TLS key pair, a self-signed certificate and a random password for logging in will be generated. You can see the latter with `docker compose logs`. The user is `test`. - -After running `docker compose build` & `docker compose up -d` you can browse to [https://localhost:8443](https://localhost:8443) - ## Debugging - For debugging you can set the `LIBCLOUD_DEBUG` environment variable to a path like `/dev/stderr` @@ -79,7 +68,3 @@ After running `docker compose build` & `docker compose up -d` you can browse to - [Azure](https://libcloud.readthedocs.io/en/stable/compute/drivers/azure_arm.html) - [GCE](https://libcloud.readthedocs.io/en/stable/compute/drivers/gce.html) - [Openstack](https://libcloud.readthedocs.io/en/stable/compute/drivers/openstack.html) - -## Similar projects - - - [public cloud watch](https://github.com/SUSE/pcw/) diff --git a/cloudview/azure.py b/cloudview/azure.py index dbbdd99..90216d2 100644 --- a/cloudview/azure.py +++ b/cloudview/azure.py @@ -7,13 +7,12 @@ import os from functools import cached_property -from cachetools import cached, TTLCache from libcloud.compute.base import Node, NodeDriver from libcloud.compute.providers import get_driver from libcloud.compute.types import Provider, LibcloudError from requests.exceptions import RequestException -from cloudview.instance import Instance, CSP, CACHED_SECONDS +from cloudview.instance import Instance, CSP from cloudview.utils import utc_date @@ -80,7 +79,6 @@ def _get_instance(self, instance_id: str, params: dict) -> Instance: node = self.driver.ex_get_node(instance_id) return self._node_to_instance(node) - @cached(cache=TTLCache(maxsize=1, ttl=CACHED_SECONDS)) def _get_instances(self) -> list[Instance]: return [self._node_to_instance(node) for node in self.driver.list_nodes()] diff --git a/cloudview/cloudview.py b/cloudview/cloudview.py index 1ff39b8..08d8c0c 100644 --- a/cloudview/cloudview.py +++ b/cloudview/cloudview.py @@ -8,17 +8,8 @@ import logging import sys from concurrent.futures import ThreadPoolExecutor -from json import JSONEncoder -from io import StringIO from operator import itemgetter from typing import Any -from urllib.parse import urlencode, quote, unquote - -from wsgiref.simple_server import make_server -from pyramid.view import view_config -from pyramid.config import Configurator -from pyramid.response import Response -from pyramid.request import Request import yaml from libcloud.compute.types import Provider, LibcloudError @@ -93,114 +84,21 @@ def print_instances(client: CSP) -> None: ) for instance in instances: instance.provider = "/".join([instance.provider, instance.cloud]) - if args.output == "html": - params = urlencode(instance.params) - resource = "/".join([instance.provider.lower(), f"{instance.id}?{params}"]) - instance.href = f"instance/{resource}" assert not isinstance(instance.time, str) instance.time = dateit(instance.time, args.time) Output().info(instance) -def print_info() -> Response | None: +def print_info() -> None: """ Print information about instances """ clients = get_clients(config_file=args.config) - sys.stdout = StringIO() if args.port else sys.stdout Output().header() if len(clients) > 0: with ThreadPoolExecutor(max_workers=len(clients)) as executor: executor.map(print_instances, clients) Output().footer() - if args.port: - response = sys.stdout.getvalue() # type: ignore - sys.stdout.close() - return response - return None - - -def handle_requests(request: Request) -> Response | None: - """ - Handle HTTP requests - """ - logging.info(request) - response = print_info() - return Response(response) - - -def test(request: Request | None = None) -> Response | None: - """ - Used for testing - """ - if request: - logging.info(request) - response = "OK" - return Response(response) - return None - - -def not_found() -> Response: - """ - Not found! - """ - return Response("Not found!", status=404) - - -def valid_elem(elem: str) -> bool: - """ - Validates URL path component - """ - return ( - 0 < len(elem) < 64 - and elem.isascii() - and "/" not in elem - and elem == unquote(quote(elem, safe="")) - ) - - -@view_config(route_name="instance") -def handle_instance(request: Request) -> Response: - """ - Handle HTTP requests for instances - """ - logging.info(request) - provider = request.matchdict["provider"] - cloud = request.matchdict["cloud"] - instance_id = request.matchdict["instance_id"] - if ( - provider not in PROVIDERS - or not valid_elem(cloud) - or not valid_elem(instance_id) - ): - return not_found() - client = list(get_clients(config_file=args.config, provider=provider, cloud=cloud))[ - 0 - ] - if client is None: - return not_found() - if client is not None: - info = client.get_instance(instance_id, **request.params) - if info is None: - return not_found() - response = JSONEncoder(default=str, indent=4, sort_keys=True).encode(info.extra) - return Response(response, content_type="application/json; charset=utf-8") - - -def web_server() -> None: - """ - Setup the WSGI server - """ - with Configurator() as config: - config.add_route("handle_requests", "/") - config.add_view(handle_requests, route_name="handle_requests") - config.add_route("test", "/test") - config.add_view(test, route_name="test") - config.add_route("instance", "instance/{provider}/{cloud}/{instance_id}") - config.scan() - app = config.make_wsgi_app() - server = make_server("0.0.0.0", args.port, app) - server.serve_forever() def parse_args() -> argparse.Namespace: @@ -230,12 +128,9 @@ def parse_args() -> argparse.Namespace: "-o", "--output", default="text", - choices=["text", "html", "json"], + choices=["text", "json"], help="output type", ) - argparser.add_argument( - "-p", "--port", type=port_number, help="run a web server on specified port" - ) argparser.add_argument( "-P", "--providers", @@ -266,15 +161,6 @@ def parse_args() -> argparse.Namespace: return argparser.parse_args() -def port_number(port: str) -> int: - """ - Check port argument - """ - if port.isdigit() and 1 <= int(port) <= 65535: - return int(port) - raise argparse.ArgumentTypeError(f"{port} is an invalid port number") - - def main() -> None: """ Main function @@ -309,14 +195,7 @@ def main() -> None: if args.verbose: keys |= {"id": ""} - if args.port: - args.output = "html" - Output(type=args.output.lower(), keys=keys, refresh_seconds=600) - - if args.port: - web_server() - sys.exit(1) - + Output(type=args.output.lower(), keys=keys) print_info() diff --git a/cloudview/ec2.py b/cloudview/ec2.py index dcfcda1..03ec55c 100644 --- a/cloudview/ec2.py +++ b/cloudview/ec2.py @@ -7,12 +7,11 @@ import os import concurrent.futures -from cachetools import cached, TTLCache from libcloud.compute.base import Node, NodeDriver from libcloud.compute.providers import get_driver from libcloud.compute.types import Provider, LibcloudError, InvalidCredsError -from cloudview.instance import Instance, CSP, CACHED_SECONDS +from cloudview.instance import Instance, CSP from cloudview.utils import utc_date @@ -62,7 +61,6 @@ def _get_instance(self, instance_id: str, params: dict) -> Instance: node = self._drivers[region].list_nodes(ex_node_ids=[instance_id])[0] return self._node_to_instance(node, region) - @cached(cache=TTLCache(maxsize=1, ttl=CACHED_SECONDS)) def _get_instances(self) -> list[Instance]: instances = [] with concurrent.futures.ThreadPoolExecutor( diff --git a/cloudview/footer.html b/cloudview/footer.html deleted file mode 100644 index 6754d21..0000000 --- a/cloudview/footer.html +++ /dev/null @@ -1,18 +0,0 @@ -

Last updated:

- -

- - diff --git a/cloudview/gce.py b/cloudview/gce.py index f5f34a5..bded726 100644 --- a/cloudview/gce.py +++ b/cloudview/gce.py @@ -9,14 +9,13 @@ import concurrent.futures from functools import cached_property -from cachetools import cached, TTLCache from libcloud.compute.base import Node, NodeDriver from libcloud.compute.drivers.gce import GCEZone from libcloud.compute.providers import get_driver from libcloud.compute.types import Provider, LibcloudError from requests.exceptions import RequestException -from cloudview.instance import Instance, CSP, CACHED_SECONDS +from cloudview.instance import Instance, CSP from cloudview.utils import utc_date, read_file @@ -86,7 +85,6 @@ def _get_instance(self, instance_id: str, params: dict) -> Instance: node = self.driver.ex_get_node(params["name"], zone=params["zone"]) return self._node_to_instance(node) - @cached(cache=TTLCache(maxsize=1, ttl=CACHED_SECONDS)) def _get_instances(self) -> list[Instance]: zones = self.driver.ex_list_zones() instances = [] diff --git a/cloudview/header.html b/cloudview/header.html deleted file mode 100644 index 2859e83..0000000 --- a/cloudview/header.html +++ /dev/null @@ -1,34 +0,0 @@ - - - -Instances - - -

CloudView

diff --git a/cloudview/instance.py b/cloudview/instance.py index 8dd1d16..3e85d45 100644 --- a/cloudview/instance.py +++ b/cloudview/instance.py @@ -7,13 +7,11 @@ from datetime import datetime from typing import Any -from cachetools import cached, TTLCache from libcloud.compute.types import NodeState, LibcloudError from requests.exceptions import RequestException from cloudview.singleton import Singleton2 -CACHED_SECONDS = 300 STATES = [str(getattr(NodeState, _)) for _ in dir(NodeState) if _.isupper()] @@ -63,7 +61,6 @@ def __init__(self, cloud: str = "") -> None: def __repr__(self) -> str: return f"{self.__class__.__name__}(cloud='{self.cloud}')" - @cached(cache=TTLCache(maxsize=1, ttl=300)) def _get_instances(self) -> list[Instance]: raise NotImplementedError("CSP._get_instances needs to be overridden") diff --git a/cloudview/openstack.py b/cloudview/openstack.py index 1d4897a..729ac86 100644 --- a/cloudview/openstack.py +++ b/cloudview/openstack.py @@ -9,14 +9,13 @@ from functools import cached_property from urllib.parse import urlparse -from cachetools import cached, TTLCache import libcloud.security from libcloud.compute.base import Node, NodeDriver, NodeSize from libcloud.compute.providers import get_driver from libcloud.compute.types import Provider, LibcloudError from requests.exceptions import RequestException -from cloudview.instance import Instance, CSP, CACHED_SECONDS +from cloudview.instance import Instance, CSP from cloudview.utils import utc_date @@ -96,7 +95,6 @@ def _get_size(self, size_id: str) -> str: return size.name return "unknown" - @cached(cache=TTLCache(maxsize=1, ttl=CACHED_SECONDS)) def _get_sizes(self) -> list[NodeSize]: try: return self.driver.list_sizes() @@ -108,7 +106,6 @@ def _get_instance(self, instance_id: str, _: dict) -> Instance: node = self.driver.ex_get_node_details(instance_id) return self._node_to_instance(node) - @cached(cache=TTLCache(maxsize=1, ttl=CACHED_SECONDS)) def _get_instances(self) -> list[Instance]: return [ self._node_to_instance(node) diff --git a/cloudview/output.py b/cloudview/output.py index a5d45e0..ee09da0 100644 --- a/cloudview/output.py +++ b/cloudview/output.py @@ -1,32 +1,16 @@ """ -Handle tabular output in these formats: text, json & html +Handle tabular output in these formats: text, json """ -import html import json -import os - -from jinja2 import Template from cloudview.singleton import Singleton -def html_tag(tag: str, content: str = "", **kwargs) -> str: - """ - HTML tag - """ - attributes = " ".join( - f'{key}="{value}"' for key, value in kwargs.items() if value is not None - ) - if attributes: - return f"<{tag} {attributes}>{content}" - return f"<{tag}>{content}" - - # pylint: disable=redefined-builtin class Output(metaclass=Singleton): """ - Helper class to handle tabular output in text, json or html + Helper class to handle tabular output in text, json """ def __init__( @@ -36,12 +20,11 @@ def __init__( **kwargs, ) -> None: """ - type must be either text, json or html + type must be either text, json fmt is the format string used for text keys are the items in the dictionary - seconds is the refresh time for HTML output """ - if type not in ("text", "json", "html"): + if type not in ("text", "json"): raise ValueError(f"Invalid type: {type}") self._type = type if isinstance(keys, (list, tuple)): @@ -63,15 +46,6 @@ def header(self) -> None: print( self._output_format.format_map({key: key.upper() for key in self._keys}) ) - elif self._type == "html": - cells = "".join(html_tag("th", key.upper()) for key in self._keys) - table_header = html_tag("thead", html_tag("tr", cells)) - table_header = f'{table_header}' - with open( - os.path.join(os.path.dirname(__file__), "header.html"), encoding="utf-8" - ) as file: - header = file.read() - print(Template(header).render(**self._kwargs), table_header) def info(self, item) -> None: """ @@ -84,14 +58,6 @@ def info(self, item) -> None: print(self._output_format.format_map(item.__dict__)) elif self._type == "json": self._items.append(item if isinstance(item, dict) else item.__dict__) - elif self._type == "html": - info = { - k: html.escape(item[k]) if isinstance(item[k], str) else item[k] - for k in self._keys - } - info["name"] = html_tag("a", html.escape(item["name"]), href=item["href"]) - cells = "".join(html_tag("td", info[key]) for key in self._keys) - print(html_tag("tr", cells)) def footer(self) -> None: """ @@ -99,10 +65,3 @@ def footer(self) -> None: """ if self._type == "json": print(json.dumps(self._items, indent=2, default=str)) - elif self._type == "html": - with open( - os.path.join(os.path.dirname(__file__), "footer.html"), encoding="utf-8" - ) as file: - footer = file.read() - table_footer = "
" - print(table_footer, Template(footer).render(**self._kwargs)) diff --git a/examples/docker-compose.yml b/examples/docker-compose.yml deleted file mode 100644 index 970a283..0000000 --- a/examples/docker-compose.yml +++ /dev/null @@ -1,23 +0,0 @@ -version: '3.8' - -services: - app: - build: . - command: --config /clouds.yaml --sort time --port 7777 --verbose - environment: - - TZ=Europe/Berlin - volumes: - - ${PWD}/examples/clouds.yaml:/clouds.yaml:ro - # Must be the same path mentioned in clouds.yaml - - ${PWD}/gce.json:/gce.json:ro - restart: always - nginx: - build: nginx - environment: - - APP_PORT=7777 - - NGINX_HOST=${NGINX_HOST:-localhost} - - PASS=${PASS:-} - ports: - - "8443:443" - read_only: true - restart: always diff --git a/nginx/Dockerfile b/nginx/Dockerfile deleted file mode 100644 index b58f1ea..0000000 --- a/nginx/Dockerfile +++ /dev/null @@ -1,16 +0,0 @@ -FROM nginx:alpine - -RUN apk --no-cache add bash openssl - -COPY site.conf.template /etc/nginx/conf.d/ -COPY entrypoint.sh /run -RUN chmod +x /run/entrypoint.sh && \ - ln -sf /run/site.conf /etc/nginx/conf.d/default.conf - -COPY favicon.ico /usr/share/nginx/html/ - -EXPOSE 443 - -VOLUME ["/var/cache/nginx", "/run", "/etc/nginx/ssl"] - -ENTRYPOINT ["/run/entrypoint.sh"] diff --git a/nginx/entrypoint.sh b/nginx/entrypoint.sh deleted file mode 100644 index f2a852b..0000000 --- a/nginx/entrypoint.sh +++ /dev/null @@ -1,51 +0,0 @@ -#!/bin/bash - -set -e -umask 077 - -# shellcheck disable=SC2016 -envsubst '$APP_PORT $NGINX_HOST' < /etc/nginx/conf.d/site.conf.template > /run/site.conf - -openssl_config() { - cat /etc/ssl/openssl.cnf - cat <<- EOF - [custom] - basicConstraints = critical,CA:false - nsCertType = server - subjectKeyIdentifier = hash - authorityKeyIdentifier = keyid,issuer:always - keyUsage = critical,digitalSignature,keyEncipherment - extendedKeyUsage = serverAuth - subjectAltName = DNS:${NGINX_HOST:-localhost} - EOF -} - -# On read-only containers, openssl won't be able to write to ~/.rnd -export RANDFILE=/dev/null - -SSL=/etc/nginx/ssl -if [ ! -f $SSL/key.pem ] ; then - # Generate a random Base64 password - openssl rand -base64 48 > $SSL/key.txt - # Generate a self-signed certificate - openssl req -x509 -sha512 -newkey rsa:4096 -keyout $SSL/key.pem -out $SSL/cert.pem -days 365 -subj "/CN=${NGINX_HOST:-localhost}" -passout file:$SSL/key.txt -extensions custom -config <(openssl_config) - - # Generate a random salt of 16 characters - SALT=$(openssl rand -base64 12) - # The salt character set is [a-zA-Z0-9./] - SALT=${SALT//+/.} - if [ -z "$PASS" ] ; then - # Generate a random password - PASS=$(openssl rand -base64 48) - echo "Password for HTTP Basic Authentication is $PASS" - fi - # Hash password with salted SHA-512 - PASS=$(mkpasswd -S "$SALT" "$PASS") - echo "test:$PASS" >> $SSL/auth.htpasswd - unset PASS - chmod 644 $SSL/auth.htpasswd -elif [ ! -f $SSL/auth.htpasswd ] ; then - sed -i '/auth_basic/d' /run/site.conf -fi - -exec nginx -g 'daemon off;' diff --git a/nginx/favicon.ico b/nginx/favicon.ico deleted file mode 100644 index 0ed3145..0000000 Binary files a/nginx/favicon.ico and /dev/null differ diff --git a/nginx/site.conf.template b/nginx/site.conf.template deleted file mode 100644 index 026c04a..0000000 --- a/nginx/site.conf.template +++ /dev/null @@ -1,59 +0,0 @@ -# Hide Nginx version -server_tokens off; - -server { - listen 80; - server_name ${NGINX_HOST}; - return 301 https://$server_name$request_uri; -} - -server { - listen 443 ssl; - server_name ${NGINX_HOST}; - - ssl_certificate_key /etc/nginx/ssl/key.pem; - ssl_password_file /etc/nginx/ssl/key.txt; - ssl_certificate /etc/nginx/ssl/cert.pem; - ssl_ciphers TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256; - ssl_protocols TLSv1.3 TLSv1.2; - ssl_prefer_server_ciphers on; - ssl_session_cache shared:SSL:20m; - ssl_session_timeout 1d; - ssl_session_tickets off; - #ssl_stapling on; - #ssl_stapling_verify on; - - proxy_connect_timeout 300; - proxy_send_timeout 300; - proxy_read_timeout 300; - send_timeout 300; - - location /favicon.ico { - root /usr/share/nginx/html; - } - - location / { - limit_except GET { - deny all; - } - auth_basic on; - auth_basic_user_file /etc/nginx/ssl/auth.htpasswd; - proxy_pass http://app:${APP_PORT}; - proxy_set_header Host $http_host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - # Remove authentication header - proxy_set_header Authorization ""; - # Protect against HTTPoxy - proxy_set_header Proxy ""; - # Protect against gzip attacks - proxy_set_header Accept-Encoding ""; - #add_header Strict-Transport-Security max-age=15768000; - # Enable keepalive - proxy_http_version 1.1; - proxy_set_header Connection ""; - proxy_redirect off; - proxy_buffering off; - } -} diff --git a/requirements-dev.txt b/requirements-dev.txt index e6151bc..bb9e590 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,8 +1,5 @@ apache-libcloud -cachetools cryptography -Jinja2 -pyramid python-dateutil pytz PyYAML diff --git a/requirements-test.txt b/requirements-test.txt index f355a82..35efe5b 100644 --- a/requirements-test.txt +++ b/requirements-test.txt @@ -11,8 +11,4 @@ mypy types-python-dateutil types-pytz types-PyYAML -types-cachetools types-requests -podman -docker -selenium diff --git a/requirements.txt b/requirements.txt index 472f9cc..6bdfb78 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,27 +1,13 @@ apache-libcloud==3.8.0 -cachetools==5.4.0 -certifi==2024.7.4 +certifi==2024.8.30 cffi==1.17.0 charset-normalizer==3.3.2 cryptography==43.0.0 -hupper==1.12.1 -idna==3.7 -Jinja2==3.1.4 -MarkupSafe==2.1.5 -PasteDeploy==3.1.0 -plaster==1.1.2 -plaster-pastedeploy==1.0.1 +idna==3.8 pycparser==2.22 -pyramid==2.0.2 python-dateutil==2.9.0.post0 pytz==2024.1 PyYAML==6.0.2 requests==2.32.3 -setuptools==72.2.0 six==1.16.0 -translationstring==1.4 urllib3==2.2.2 -venusian==3.1.0 -WebOb==1.8.8 -zope.deprecation==5.0 -zope.interface==7.0.1 diff --git a/tests/test_cloudview.py b/tests/test_cloudview.py deleted file mode 100644 index 5ce2228..0000000 --- a/tests/test_cloudview.py +++ /dev/null @@ -1,55 +0,0 @@ -# pylint: disable=missing-module-docstring,missing-function-docstring,missing-class-docstring,too-few-public-methods,redefined-outer-name - -import argparse -import pytest -from cloudview.cloudview import port_number, valid_elem - - -def test_valid_port_number(): - valid_ports = ["1", "80", "443", "65535"] - for port in valid_ports: - result = port_number(port) - assert result == int(port) - - -def test_invalid_port_number_below_range(): - invalid_ports = ["0", "-1", "-100", "65536", "99999"] - for port in invalid_ports: - with pytest.raises(argparse.ArgumentTypeError): - port_number(port) - - -def test_invalid_port_number_non_numeric(): - invalid_ports = ["abc", "1a2b", "port"] - for port in invalid_ports: - with pytest.raises(argparse.ArgumentTypeError): - port_number(port) - - -def test_valid_elem_valid_input(): - assert valid_elem("example") is True - assert valid_elem("path123") is True - - -def test_valid_elem_empty_input(): - assert valid_elem("") is False - - -def test_valid_elem_too_long_input(): - assert valid_elem("a" * 64) is False - - -def test_valid_elem_contains_slash(): - assert valid_elem("with/slash") is False - - -def test_valid_elem_non_ascii_input(): - assert valid_elem("résumé") is False - - -def test_valid_elem_url_encoding(): - assert valid_elem("hello%20world") is True - - -def test_valid_elem_url_decoding(): - assert valid_elem("hello world") is True diff --git a/tests/test_instance.py b/tests/test_instance.py index e2ab4c7..39e560f 100644 --- a/tests/test_instance.py +++ b/tests/test_instance.py @@ -1,6 +1,5 @@ # pylint: disable=missing-module-docstring,missing-function-docstring,missing-class-docstring,no-member,eval-used import pytest -from cachetools import cached, TTLCache from cloudview.instance import Instance, CSP @@ -118,7 +117,6 @@ def test_instance_unknown_attribute(): class MockCSP(CSP): - @cached(cache=TTLCache(maxsize=1, ttl=300)) def _get_instances(self): return [ Instance( diff --git a/tests/test_output.py b/tests/test_output.py index d31a61a..e695fdd 100644 --- a/tests/test_output.py +++ b/tests/test_output.py @@ -5,7 +5,7 @@ import pytest from cloudview.instance import Instance -from cloudview.output import Output, html_tag +from cloudview.output import Output @pytest.fixture @@ -18,11 +18,6 @@ def json_output(): return Output(type="json") -@pytest.fixture -def html_output(): - return Output(type="html", keys=["name", "age", "href"]) - - # Use the "monkeypatch" fixture to reset the singleton instance before each test @pytest.fixture(autouse=True) def reset_singleton(monkeypatch): @@ -48,29 +43,6 @@ def test_text_output_info(text_output, capsys): assert captured.out == expected_info -def test_html_output_header(html_output, capsys): - expected_header = "NAME" - html_output.header() - captured = capsys.readouterr() - assert expected_header in captured.out - - -def test_html_output_info(html_output, capsys): - expected_info = ( - 'John30john.html' - ) - item = {"name": "John", "age": 30, "href": "john.html"} - html_output.info(item) - captured = capsys.readouterr() - assert expected_info in captured.out - - -def test_html_output_footer(html_output, capsys): - html_output.footer() - captured = capsys.readouterr() - assert "" in captured.out - - def test_json_output_dict(json_output, capsys): json_output.header() info = {"name": "John", "age": 30} @@ -98,28 +70,3 @@ def test_json_output_obj(json_output, capsys): json_output.footer() captured = capsys.readouterr() assert [info.__dict__] == json.loads(captured.out) - - -# Test cases for the html_tag function -def test_html_tag_basic(): - # Test with a simple HTML tag - result = html_tag("div", "Hello, World!") - assert result == "
Hello, World!
" - - -def test_html_tag_with_attributes(): - # Test with attributes - result = html_tag("a", "Click me", href="https://example.com", target="_blank") - assert result == 'Click me' - - -def test_html_tag_empty_content(): - # Test with empty content - result = html_tag("p") - assert result == "

" - - -def test_html_tag_empty_attributes(): - # Test with empty attributes - result = html_tag("span", "This is a span", **{}) - assert result == "This is a span" diff --git a/tests/test_selenium.py b/tests/test_selenium.py deleted file mode 100644 index 998ec48..0000000 --- a/tests/test_selenium.py +++ /dev/null @@ -1,130 +0,0 @@ -# pylint: disable=missing-module-docstring,missing-function-docstring,missing-class-docstring,redefined-outer-name,no-member,unused-argument - -import contextlib -import logging -import random -import os -import shlex -import shutil -import sys -from subprocess import DEVNULL - -import pytest -import docker -from docker.errors import DockerException -from requests.exceptions import RequestException -from podman import PodmanClient -from podman.errors import APIError, PodmanError -from selenium.webdriver import firefox -from selenium.common.exceptions import WebDriverException - - -@pytest.fixture(scope="session") -def client(): - if os.getenv("SKIP_SELENIUM"): - pytest.skip("Skipping because SKIP_SELENIUM is set") - - if not shutil.which("geckodriver"): - pytest.skip("Please install geckodriver in your PATH. Skipping...") - - try: - client = docker.from_env() - except (DockerException, RequestException) as exc: - logging.warning("%s", exc) - try: - client = PodmanClient() - except (APIError, PodmanError) as exc: - pytest.skip(f"Broken Podman environment: {exc}") - if not client.info()["host"]["remoteSocket"]["exists"]: - pytest.skip("Please run systemctl --user enable --now podman.socket") - - yield client - - client.close() - - -@pytest.fixture(scope="session") -def random_port(): - # Get random number for ephemeral port, container and image name - # Typical values from /proc/sys/net/ipv4/ip_local_port_range - return random.randint(32768, 60999) - - -@pytest.fixture(scope="session") -def image(random_port, client): - image_name = f"cloudview-test{random_port}" - - # Build image - try: - client.images.build( - path=".", - dockerfile="Dockerfile", - tag=image_name, - ) - except APIError as exc: - pytest.skip(f"Broken Podman environment: {exc}") - except RequestException as exc: - pytest.skip(f"Broken Docker environment: {exc}") - except (DockerException, PodmanError) as exc: - pytest.fail(f"{exc}") - - yield image_name - - # Cleanup - with contextlib.suppress(APIError, PodmanError, DockerException, RequestException): - client.images.remove(image_name) - - -@pytest.fixture(scope="session") -def container(random_port, image, client): - command = shlex.split(f"--port {7777}") - environment = {} - if os.getenv("DEBUG"): - command.extend(shlex.split("--log debug")) - environment.update({"LIBCLOUD_DEBUG": 1}) - try: - # Run container - container = client.containers.run( - image=image, - name=image, - detach=True, - command=command, - environment=environment, - ports={f"{7777}/tcp": random_port}, - ) - except (APIError, PodmanError, DockerException, RequestException) as exc: - pytest.fail(f"{exc}") - - yield container - - # Cleanup - with contextlib.suppress(APIError, PodmanError, DockerException, RequestException): - print(container.logs(), file=sys.stderr) - with contextlib.suppress(APIError, PodmanError, DockerException, RequestException): - container.stop() - with contextlib.suppress(APIError, PodmanError, DockerException, RequestException): - container.remove() - - -@pytest.fixture -def browser(container): - service = firefox.service.Service( - log_output=sys.stderr if os.getenv("DEBUG") else DEVNULL - ) - options = firefox.options.Options() - options.add_argument("--headless") - try: - driver = firefox.webdriver.WebDriver(options=options, service=service) - except WebDriverException as exc: - pytest.fail(f"{exc}") - driver.set_page_load_timeout(30) - yield driver - driver.quit() - - -def test_web(random_port, browser): - try: - browser.get(f"http://127.0.0.1:{random_port}") - except WebDriverException as exc: - pytest.fail(f"{exc}") - assert "Instances" in browser.title