python-chi 1.1.0__tar.gz → 1.2.2__tar.gz

python_chi-1.2.2/.github/workflows/linting.yml

@@ -0,0 +1,25 @@
+name: Linting
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  lint-with-ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      - name: Install the code linting and formatting tool Ruff
+        run: pip install ruff
+        
+        # run pass-fail test for any lint rule violations
+      - name: Lint code with Ruff
+        run: ruff check --output-format=github
+
+        # pas-fail test if any formatting would be applied, and output diff
+      - name: Check code formatting with Ruff
+        run: ruff format --diff

python_chi-1.2.2/ChangeLog

@@ -0,0 +1,7 @@
+CHANGES
+=======
+
+v1.2.2
+------
+
+* Fix nova API version

{python_chi-1.1.0 → python_chi-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-chi
-Version: 1.1.0
+Version: 1.2.2
 Summary: Helper library for Chameleon Infrastructure (CHI) testbed
 Home-page: https://www.chameleoncloud.org
 Author: University of Chicago

{python_chi-1.1.0 → python_chi-1.2.2}/chi/__init__.py

@@ -1,7 +1,7 @@
 from .clients import (
-    connection,
     blazar,
     cinder,
+    connection,
     glance,
     ironic,
     keystone,
@@ -10,8 +10,7 @@ from .clients import (
     nova,
     zun,
 )
-from .context import reset, set, get, params, session, use_site
-
+from .context import get, params, reset, session, set, use_site
 
 __all__ = [
     "get",

{python_chi-1.1.0 → python_chi-1.2.2}/chi/clients.py

@@ -1,26 +1,26 @@
-from .context import session
-
 # Import all of the client classes for type annotations.
 # We have to do this because we lazy-import the client definitions
 # inside each function to reduce runtime dependencies.
 from typing import TYPE_CHECKING
 
+from .context import session
+
 if TYPE_CHECKING:
-    from openstack.connection import Connection
     from blazarclient.client import Client as BlazarClient
     from cinderclient.client import Client as CinderClient
     from glanceclient.client import Client as GlanceClient
+    from ironicclient import client as IronicClient
+    from keystoneclient.v3.client import Client as KeystoneClient
     from manilaclient.client import Client as ManilaClient
     from neutronclient.v2_0.client import Client as NeutronClient
     from novaclient.client import Client as NovaClient
-    from ironicclient import client as IronicClient
-    from keystoneclient.v3.client import Client as KeystoneClient
+    from openstack.connection import Connection
     from zunclient.client import Client as ZunClient
 
 
 session_factory = session
 
-NOVA_API_VERSION = "2.10"
+NOVA_API_VERSION = "2.61"
 ZUN_API_VERSION = "1.41"
 
 

{python_chi-1.1.0 → python_chi-1.2.2}/chi/container.py

@@ -24,13 +24,12 @@ from packaging.version import Version
 from zunclient.exceptions import NotFound
 
 from chi import context, util
+from chi import network as chi_network
 
 from .clients import connection, zun
 from .context import session
 from .exception import ResourceError, ServiceError
 from .network import bind_floating_ip, get_free_floating_ip
-from chi import network as chi_network
-
 
 DEFAULT_IMAGE_DRIVER = "docker"
 DEFAULT_NETWORK = "containernet1"

{python_chi-1.1.0 → python_chi-1.2.2}/chi/context.py

@@ -11,6 +11,7 @@ from IPython.display import display
 from keystoneauth1 import loading, session
 from keystoneauth1.identity.v3 import OidcAccessToken
 from keystoneauth1.loading.conf import _AUTH_SECTION_OPT, _AUTH_TYPE_OPT
+from keystoneclient import exceptions as keystone_exceptions
 from keystoneclient.v3.client import Client as KeystoneClient
 from oslo_config import cfg
 
@@ -72,8 +73,7 @@ _auth_plugin = None
 _session = None
 _sites = {}
 
-# You must manually opt into our 1.0 features.
-version = "0.17.12"
+version = "1.1"
 
 
 def printerr(msg):
@@ -144,7 +144,7 @@ def _default_from_env(opts, group=None):
             getattr(opt, "deprecated_opts", getattr(opt, "deprecated", None)) or []
         )
         for o in all_opts:
-            v = os.environ.get(f'OS_{o.name.replace("-", "_").upper()}')
+            v = os.environ.get(f"OS_{o.name.replace('-', '_').upper()}")
             if v:
                 return v
 
@@ -384,19 +384,20 @@ def use_site(site_name: str) -> None:
     if not site:
         raise CHIValueError(
             (
-                f'No site named "{site_name}" exists! Possible values: '
-                ", ".join(_sites.keys())
+                f'No site named "{site_name}" exists! Possible values: , '.join(
+                    _sites.keys()
+                )
             )
         )
 
-    set("auth_url", f'{site["web"]}:5000/v3')
+    set("auth_url", f"{site['web']}:5000/v3")
     set("region_name", site["name"])
 
     output = [
         f"Now using {site_name}:",
-        f'URL: {site.get("web")}',
-        f'Location: {site.get("location")}',
-        f'Support contact: {site.get("user_support_contact")}',
+        f"URL: {site.get('web')}",
+        f"Location: {site.get('location')}",
+        f"Support contact: {site.get('user_support_contact')}",
     ]
     print("\n".join(output))
 
@@ -465,7 +466,10 @@ def list_projects(show: str = None) -> List[str]:
         region_name=getattr(keystone_session, "region_name", None),
     )
 
-    projects = keystone_client.projects.list(user=keystone_session.get_user_id())
+    try:
+        projects = keystone_client.projects.list(user=keystone_session.get_user_id())
+    except keystone_exceptions.Unauthorized:
+        raise ResourceError("Failed to retrieve projects. Check your credentials.")
     project_names = [project.name for project in projects]
 
     if show == "widget":

{python_chi-1.1.0 → python_chi-1.2.2}/chi/hardware.py

@@ -1,17 +1,16 @@
+import logging
 from collections import defaultdict
 from concurrent.futures import ThreadPoolExecutor
 from dataclasses import dataclass
 from datetime import datetime, timedelta, timezone
 from typing import List, Optional, Set, Tuple
 
+import requests
+
 from chi import exception
 
 from .clients import blazar, connection
-from .context import get, RESOURCE_API_URL, EDGE_RESOURCE_API_URL, session
-
-
-import requests
-import logging
+from .context import EDGE_RESOURCE_API_URL, RESOURCE_API_URL, get, session
 
 LOG = logging.getLogger(__name__)
 

{python_chi-1.1.0 → python_chi-1.2.2}/chi/image.py

@@ -2,7 +2,7 @@ from dataclasses import dataclass
 from datetime import datetime
 from typing import List, Optional
 
-from glanceclient.exc import NotFound
+from glanceclient.exc import HTTPBadRequest, NotFound
 from packaging.version import Version
 
 from chi import context
@@ -79,12 +79,15 @@ def get_image(name: str) -> Image:
         ResourceError: If multiple images are found with the same name.
     """
     if Version(context.version) >= Version("1.0"):
-        glance_images = list(glance().images.list(filters={"name": name}))
-        if not glance_images:
-            raise CHIValueError(f'No images found matching name "{name}"')
-        elif len(glance_images) > 1:
-            raise ResourceError(f'Multiple images found matching name "{name}"')
-        return Image.from_glance_image(glance_images[0])
+        try:
+            glance_images = list(glance().images.list(filters={"name": name}))
+            if not glance_images:
+                raise CHIValueError(f'No images found matching name "{name}"')
+            elif len(glance_images) > 1:
+                raise ResourceError(f'Multiple images found matching name "{name}"')
+            return Image.from_glance_image(glance_images[0])
+        except HTTPBadRequest:
+            return Image(None, None, False, name)
     try:
         return glance().images.get(name)
     except NotFound:

{python_chi-1.1.0 → python_chi-1.2.2}/chi/jupyterhub.py

@@ -1,4 +1,5 @@
 import os
+
 import requests
 
 ACCESS_TOKEN_ENDPOINT = "tokens"

{python_chi-1.1.0 → python_chi-1.2.2}/chi/lease.py

@@ -11,7 +11,7 @@ from IPython.display import display
 from ipywidgets import HTML
 from packaging.version import Version
 
-from chi import context, util
+from chi import context, server, util
 
 from .clients import blazar
 from .context import _is_ipynb
@@ -172,6 +172,7 @@ class Lease:
         node_reservations (list): List of node reservations associated with the lease.
         fip_reservations (list): List of floating IP reservations associated with the lease.
         network_reservations (list): List of network reservations associated with the lease.
+        flavor_reservations (list): List of flavor reservations associated with the lease.
         events (list): List of events associated with the lease.
     """
 
@@ -192,6 +193,7 @@ class Lease:
         self.device_reservations = []
         self.node_reservations = []
         self.fip_reservations = []
+        self.flavor_reservations = []
         self.network_reservations = []
         self._events = []
 
@@ -239,6 +241,7 @@ class Lease:
         self.device_reservations.clear()
         self.node_reservations.clear()
         self.fip_reservations.clear()
+        self.flavor_reservations.clear()
         self.network_reservations.clear()
 
         for reservation in lease_json.get("reservations", []):
@@ -249,6 +252,8 @@ class Lease:
                 self.node_reservations.append(reservation)
             elif resource_type == "virtual:floatingip":
                 self.fip_reservations.append(reservation)
+            elif resource_type == "flavor:instance":
+                self.flavor_reservations.append(reservation)
             elif resource_type == "network":
                 self.network_reservations.append(reservation)
 
@@ -347,6 +352,23 @@ class Lease:
         """
         add_fip_reservation(reservation_list=self.fip_reservations, count=amount)
 
+    def add_flavor_reservation(self, id, amount=1):
+        """
+        Add a reservation for a KVM flavor to the list of reservations.
+
+        Args:
+            id (str): The ID of the flavor to reserve
+            count (int): The number of floating IPs to reserve.
+        """
+        self.flavor_reservations.append(
+            {
+                "resource_type": "flavor:instance",
+                "flavor_id": id,
+                "amount": amount,
+                "affinity": None,
+            }
+        )
+
     def add_network_reservation(
         self, network_name: str, usage_type: str = None, stitch_provider: str = None
     ):
@@ -404,6 +426,7 @@ class Lease:
             self.device_reservations
             + self.node_reservations
             + self.fip_reservations
+            + self.flavor_reservations
             + self.network_reservations
         )
 
@@ -414,7 +437,6 @@ class Lease:
                 start_date=self.start_date,
                 end_date=self.end_date,
             )
-
             if response:
                 self._populate_from_json(response)
             else:
@@ -505,12 +527,12 @@ class Lease:
         <h2>Lease Details</h2>
         <table>
             <tr><th>Name</th><td>{self.name}</td></tr>
-            <tr><th>ID</th><td>{self.id or 'N/A'}</td></tr>
-            <tr><th>Status</th><td>{self.status or 'N/A'}</td></tr>
-            <tr><th>Start Date</th><td>{self.start_date or 'N/A'}</td></tr>
-            <tr><th>End Date</th><td>{self.end_date or 'N/A'}</td></tr>
-            <tr><th>User ID</th><td>{self.user_id or 'N/A'}</td></tr>
-            <tr><th>Project ID</th><td>{self.project_id or 'N/A'}</td></tr>
+            <tr><th>ID</th><td>{self.id or "N/A"}</td></tr>
+            <tr><th>Status</th><td>{self.status or "N/A"}</td></tr>
+            <tr><th>Start Date</th><td>{self.start_date or "N/A"}</td></tr>
+            <tr><th>End Date</th><td>{self.end_date or "N/A"}</td></tr>
+            <tr><th>User ID</th><td>{self.user_id or "N/A"}</td></tr>
+            <tr><th>Project ID</th><td>{self.project_id or "N/A"}</td></tr>
         </table>
 
 
@@ -534,6 +556,11 @@ class Lease:
         {"".join(f"<li>ID: {r.get('id', 'N/A')}, Status: {r.get('status', 'N/A')}, Resource type: {r.get('resource_type', 'N/A')}, Network Name: {r.get('network_name', 'N/A')}</li>" for r in self.network_reservations)}
         </ul>
 
+        <h3>Flavor Reservations</h3>
+        <ul>
+        {"".join(f"<li>ID: {r.get('id', 'N/A')}, Status: {r.get('status', 'N/A')}, Resource type: {r.get('resource_type', 'N/A')}, Flavor: {r.get('flavor_id', 'N/A')}, Amount: {r.get('amount', 'N/A')}</li>" for r in self.flavor_reservations)}
+        </ul>
+
         <h3>Events</h3>
         <ul>
         {"".join(f"<li>Type: {e.get('event_type', 'N/A')}, Time: {e.get('time', 'N/A')}, Status: {e.get('status', 'N/A')}</li>" for e in self.events)}
@@ -571,6 +598,12 @@ class Lease:
                 f"ID: {r.get('id', 'N/A')}, Status: {r.get('status', 'N/A')}, Network Name: {r.get('network_name', 'N/A')}"
             )
 
+        print("\nFlavor Reservations:")
+        for r in self.flavor_reservations:
+            print(
+                f"ID: {r.get('id', 'N/A')}, Status: {r.get('status', 'N/A')}, Flavor: {r.get('flavor_id', 'N/A')}, Amount: {r.get('amount', 'N/A')}"
+            )
+
         print("\nEvents:")
         for e in self.events:
             print(
@@ -609,6 +642,20 @@ class Lease:
             )
         ]
 
+    def get_reserved_flavors(self):
+        """Get flavors from flavor reservations in this lease. There will be one
+        flavor per flavor reservation.
+
+        Returns:
+            List[chi.server.Flavor] of flavor
+        """
+        flavors = []
+        for res in self.flavor_reservations:
+            flavors.extend(
+                server.list_flavors(reservable=True, reservation_id=res.get("id"))
+            )
+        return flavors
+
 
 def _format_resource_properties(user_constraints, extra_constraints):
     if user_constraints:

{python_chi-1.1.0 → python_chi-1.2.2}/chi/magic.py

@@ -1,19 +1,19 @@
-from typing import Optional, List
 from datetime import timedelta
+from typing import List, Optional
+
+import matplotlib.pyplot as plt
+import networkx as nx
 
-from .server import Server
 from .container import Container
-from .exception import ResourceError
-from .lease import Lease, delete_lease
-from .image import list_images
-from .hardware import get_node_types
 from .context import (
     DEFAULT_NETWORK,
     get,
 )
-
-import networkx as nx
-import matplotlib.pyplot as plt
+from .exception import ResourceError
+from .hardware import get_node_types
+from .image import list_images
+from .lease import Lease, delete_lease
+from .server import Server
 
 
 def visualize_resources(leases: List[Lease]):

{python_chi-1.1.0 → python_chi-1.2.2}/chi/network.py

@@ -1,9 +1,7 @@
-from .clients import neutron
-from .exception import CHIValueError, ResourceError
-
 from neutronclient.common.exceptions import NotFound
 
-import json
+from .clients import neutron
+from .exception import CHIValueError, ResourceError
 
 __all__ = [
     "get_network",
@@ -141,7 +139,7 @@ def create_network(
     desc_parts = []
     if of_controller_ip and of_controller_port:
         desc_parts.append(f"OFController={of_controller_ip}:{of_controller_port}")
-    if vswitch_name != None:
+    if vswitch_name is not None:
         desc_parts.append(f"VSwitchName={vswitch_name}")
 
     network = neutron().create_network(
@@ -189,9 +187,7 @@ def list_networks() -> "list[dict]":
 
 def set_network_tag(network_id, value):
     _neutron = neutron()
-    _neutron.replace_tag('networks', network_id, {
-        'tags': [value]
-    })
+    _neutron.replace_tag("networks", network_id, {"tags": [value]})
 
 
 ##########
@@ -645,19 +641,16 @@ def remove_subnet_from_router(router_id, subnet_id):
 # Floating IPs
 ###############
 
+
 def set_floating_ip_tag(address, value):
     ip_addr = get_floating_ip(address)
     _neutron = neutron()
-    _neutron.replace_tag('floatingips', ip_addr['id'], {
-        'tags': [value]
-    })
+    _neutron.replace_tag("floatingips", ip_addr["id"], {"tags": [value]})
 
 
 def deallocate_floating_ip(address):
     _neutron = neutron()
-    _neutron.delete_floatingip(
-        get_floating_ip(address)["id"]
-    )
+    _neutron.delete_floatingip(get_floating_ip(address)["id"])
 
 
 def get_free_floating_ip(allocate=True) -> dict:
@@ -711,7 +704,7 @@ def get_or_create_floating_ip() -> "tuple[dict,bool]":
             {"floatingip": {"floating_network_id": network_id}}
         )["floatingip"]
         created = True
-        print(f'Allocated new floating IP {fip["floating_ip_address"]}')
+        print(f"Allocated new floating IP {fip['floating_ip_address']}")
     return fip, created
 
 
@@ -819,6 +812,70 @@ def nuke_network(network_ref: str):
     delete_network(network_id)
 
 
+class SecurityGroup:
+    """A wrapper class for Neutron security groups. Only supports creating."""
+
+    def __init__(self, security_group_data):
+        self.id = security_group_data.get("id")
+        self.name = security_group_data.get("name")
+        self.description = security_group_data.get("description")
+        self.rules = security_group_data.get("security_group_rules", [])
+
+    def submit(self, idempotent=False):
+        """Create a new security group."""
+        if idempotent:
+            existing_groups = neutron().list_security_groups()["security_groups"]
+            for sg in existing_groups:
+                if sg["name"] == self.name:
+                    self.id = sg["id"]
+                    return
+        security_group = neutron().create_security_group(
+            {"security_group": {"name": self.name, "description": self.description}}
+        )["security_group"]
+        self.id = security_group["id"]
+        for rule in self.rules:
+            neutron().create_security_group_rule(
+                {
+                    "security_group_rule": {
+                        "direction": rule["direction"],
+                        "port_range_min": rule.get("port_range_min"),
+                        "port_range_max": rule.get("port_range_max"),
+                        "protocol": rule["protocol"],
+                        "security_group_id": self.id,
+                    }
+                }
+            )
+
+    def add_rule(self, direction, protocol, port):
+        """Add a rule to the security group."""
+        self.rules.append(
+            {
+                "direction": direction,
+                "protocol": protocol,
+                "port_range_min": port,
+                "port_range_max": port,
+                "security_group_id": self.id,
+            }
+        )
+
+
+def list_security_groups(name_filter=None) -> "list[SecurityGroup]":
+    """List all security groups.
+
+    Args:
+        name_filter (str, optional): Filter security groups containing name.
+
+    Returns:
+        list[SecurityGroup]: A list of SecurityGroup instances.
+    """
+    security_groups = neutron().list_security_groups()["security_groups"]
+    return [
+        SecurityGroup(sg)
+        for sg in security_groups
+        if not name_filter or name_filter.lower() in sg["name"].lower()
+    ]
+
+
 ###################
 # Wizard functions
 ###################