agilicus 1.303.5__py3-none-any.whl → 1.401.1__py3-none-any.whl

agilicus/main.py

@@ -70,6 +70,8 @@ from .input_helpers import (
     pop_item_if_none,
     get_org_from_input_or_ctx,
     get_user_id_from_input_or_ctx,
+    search_direction_values,
+    page_sort_order_values,
 )
 
 from .output.console import output_formatted
@@ -87,10 +89,10 @@ from .files_pkg import files_main
 from .policy_config import policy_config_main
 from .licensing import licensing_main
 from .licensing.licenses import add_license_to_billing_sub
+from .deployments import deployments_main
 
 from .version import __version__
 
-search_direction_values = ["forwards", "backwards"]
 sort_order_values = ["ascending", "descending"]
 
 
@@ -1366,6 +1368,16 @@ def output_list_apps(ctx, orgs_by_id, apps_list):
     default=None,
     is_flag=True,
 )
+@click.option(
+    "--page-on", multiple=True, type=click.Choice(apps.page_fields), default=None
+)
+@click.option("--page-at-key", multiple=True, type=str, default=None)
+@click.option(
+    "--page-sort", multiple=True, type=click.Choice(page_sort_order_values), default=None
+)
+@click.option(
+    "--search-direction", type=click.Choice(search_direction_values), default=None
+)
 @click.pass_context
 def list_applications(ctx, organisation, org_id, **kwargs):
     # get all orgs
@@ -1428,6 +1440,20 @@ def list_environments(ctx, organisation, org_id, filter, **kwargs):
 @click.option("--hostname_or_service_name", default=None)
 @click.option("--external_hostname_or_service", default=None)
 @click.option("--show-status", is_flag=True, default=False)
+@click.option(
+    "--page-on",
+    multiple=True,
+    type=click.Choice(apps.application_service_page_fields),
+    default=None,
+)
+@click.option("--page-at-key", multiple=True, type=str, default=None)
+@click.option(
+    "--page-sort", multiple=True, type=click.Choice(page_sort_order_values), default=None
+)
+@click.option(
+    "--search-direction", type=click.Choice(search_direction_values), default=None
+)
+@click.option("--limit", default=None, type=int)
 @click.pass_context
 def list_application_services(ctx, protocol_type_list, **kwargs):
     services = apps.get_application_services(
@@ -3372,7 +3398,7 @@ def add_issuer(ctx, **kwargs):
 @click.option("--issuer", default=None)
 @click.option("--org-id", default=None)
 @click.option("--theme-file-id", type=str, default=None)
-@click.option("--upstream-redirect-uri", default=None)
+@click.option("--upstream-redirect-uri", type=str, default=None)
 @click.option("--saml-state-encryption-key", default=None)
 @click.option("--enabled/--disabled", default=None)
 @click.option(
@@ -5302,7 +5328,7 @@ def show_api_key_introspection(ctx, email, api_key, include_suborgs=False, **kwa
 @cli.command(help="list all connectors")
 @click.option("--org-id", default=None)
 @click.option("--name", default=None)
-@click.option("--limit", default=None)
+@click.option("--limit", default=None, type=int)
 @click.option("--show-stats", type=bool, default=True)
 @click.option("--no-down", is_flag=True, type=bool, default=False)
 @click.option("--page-at-id", default=None)
@@ -5324,6 +5350,16 @@ def show_api_key_introspection(ctx, email, api_key, include_suborgs=False, **kwa
     default=None,
     help="show connectors that are running the specified version",
 )
+@click.option(
+    "--page-on", multiple=True, type=click.Choice(connectors.page_fields), default=None
+)
+@click.option("--page-at-key", multiple=True, type=str, default=None)
+@click.option(
+    "--page-sort", multiple=True, type=click.Choice(page_sort_order_values), default=None
+)
+@click.option(
+    "--search-direction", type=click.Choice(search_direction_values), default=None
+)
 @click.pass_context
 def list_connectors(ctx, **kwargs):
     results = connectors.query(ctx, **kwargs)
@@ -5430,6 +5466,16 @@ def delete_agent_connector_instance(ctx, **kwargs):
 @click.option("--reverse-sort", is_flag=True, default=False)
 @click.option("--page-at-id", default=None)
 @click.option("--show-stats", default=None, type=bool)
+@click.option(
+    "--page-on", multiple=True, type=click.Choice(connectors.page_fields), default=None
+)
+@click.option("--page-at-key", multiple=True, type=str, default=None)
+@click.option(
+    "--page-sort", multiple=True, type=click.Choice(page_sort_order_values), default=None
+)
+@click.option(
+    "--search-direction", type=click.Choice(search_direction_values), default=None
+)
 @click.pass_context
 def list_agent_connectors(
     ctx, output_msfriendly=False, sort_by=None, reverse_sort=False, **kwargs
@@ -5612,6 +5658,11 @@ def show_agent_connector_info(ctx, connector_id, **kwargs):
     default=None,
     type=bool,
 )
+@click.option(
+    "--ntp-forwarding-bind",
+    default=None,
+    type=click.Choice(connectors.INTERNAL_SERVICE_BIND),
+)
 @click.pass_context
 def update_agent_connector(ctx, connector_id, **kwargs):
     result = connectors.replace_agent(ctx, connector_id, **kwargs)
@@ -5668,7 +5719,7 @@ def set_agent_connector_stats(
 
 @cli.command(name="get-agent-connector-stats")
 @click.argument("connector-id")
-@click.option("--org-id", default=None)
+@click.option("--org-id", type=str, default=None)
 @click.pass_context
 def get_agent_connector_stats(
     ctx,
@@ -5814,6 +5865,16 @@ def reissue_csr(ctx, **kwargs):
 @click.option("--updated-since", default=None, type=click.DateTime())
 @click.option("--resource-id", default=None)
 @click.option("--limit", default=500)
+@click.option(
+    "--page-on", multiple=True, type=click.Choice(desktops.page_fields), default=None
+)
+@click.option("--page-at-key", multiple=True, type=str, default=None)
+@click.option(
+    "--page-sort", multiple=True, type=click.Choice(page_sort_order_values), default=None
+)
+@click.option(
+    "--search-direction", type=click.Choice(search_direction_values), default=None
+)
 @click.pass_context
 def list_file_share_services(ctx, name=None, **kwargs):
     shares = file_shares.list_file_share_services(ctx, name=name, **kwargs)
@@ -5902,6 +5963,16 @@ def delete_file_share_service(ctx, file_share_service_id, **kwargs):
 @click.option("--has-remote-app", type=bool, default=None)
 @click.option("--resource-id", default=None)
 @click.option("--limit", default=500)
+@click.option(
+    "--page-on", multiple=True, type=click.Choice(desktops.page_fields), default=None
+)
+@click.option("--page-at-key", multiple=True, type=str, default=None)
+@click.option(
+    "--page-sort", multiple=True, type=click.Choice(page_sort_order_values), default=None
+)
+@click.option(
+    "--search-direction", type=click.Choice(search_direction_values), default=None
+)
 @click.pass_context
 def list_desktop_resources(ctx, name=None, **kwargs):
     resources = desktops.list_desktop_resources(ctx, name=name, **kwargs)
@@ -6154,10 +6225,24 @@ def bulk_delete_resource_permission(ctx, **kwargs):
     type=resources.resource_type_enum,
 )
 @click.option("--page-at-id", default=None)
-@click.option("--limit", default=500)
+@click.option("--limit", default=None, type=int)
+@click.option("--get-all", default=False, is_flag=True)
 @click.option("--show-columns", type=str, default=None)
 @click.option("--reset-columns", is_flag=True, default=False)
 @click.option("--show-stats", is_flag=True, default=None)
+@click.option(
+    "--page-on",
+    multiple=True,
+    type=click.Choice(resources.resource_page_fields),
+    default=None,
+)
+@click.option("--page-at-key", multiple=True, type=str, default=None)
+@click.option(
+    "--page-sort", multiple=True, type=click.Choice(page_sort_order_values), default=None
+)
+@click.option(
+    "--search-direction", type=click.Choice(search_direction_values), default=None
+)
 @click.pass_context
 def list_resources(ctx, reset_columns=None, show_columns=None, **kwargs):
     """Lists generic resources, which can be filtered by type, organisation, etc."""
@@ -7578,6 +7663,16 @@ def add_launcher(ctx, resource_member, **kwargs):
 @click.option("--limit", default=500)
 @click.option("--resource-id", default=None)
 @click.option("--expand-resource-members", is_flag=True, default=False)
+@click.option(
+    "--page-on", multiple=True, type=click.Choice(launchers.page_fields), default=None
+)
+@click.option("--page-at-key", multiple=True, type=str, default=None)
+@click.option(
+    "--page-sort", multiple=True, type=click.Choice(page_sort_order_values), default=None
+)
+@click.option(
+    "--search-direction", type=click.Choice(search_direction_values), default=None
+)
 @click.pass_context
 def list_launchers(ctx, **kwargs):
     ids = launchers.query(ctx, **kwargs)
@@ -8003,6 +8098,14 @@ def watch_issuers(ctx, **kwargs):
 @click.option("--client-injection-login-form-username-field", default=None)
 @click.option("--client-injection-login-form-password-field", default=None)
 @click.option("--client-injection-debug", type=bool, default=None)
+@click.option("--client-injection-login-form-username-credential", default=None)
+@click.option("--client-injection-login-form-password-credential", default=None)
+@click.option("--client-injection-login-form-username-query-selector", default=None)
+@click.option("--client-injection-login-form-password-query-selector", default=None)
+@click.option("--client-injection-login-form-username-next-selector", default=None)
+@click.option("--client-injection-login-form-password-next-selector", default=None)
+@click.option("--client-injection-login-form-login-selector", default=None)
+@click.option("--client-injection-login-form-submit-selector", default=None)
 @click.pass_context
 def update_application_configs(
     ctx,
@@ -8040,6 +8143,61 @@ def update_application_configs(
         )
 
 
+@cli.command(name="update-client-inject-form-config")
+@click.argument("app")
+@click.argument("env_name")
+@click.option("--org-id", default=None)
+@click.option("--username-query-selector", default=None)
+@click.option("--password-query-selector", default=None)
+@click.option("--username-next-selector", default=None)
+@click.option("--password-next-selector", default=None)
+@click.option("--login-selector", default=None)
+@click.option("--submit-selector", default=None)
+@click.option("--reset", is_flag=True)
+@click.pass_context
+def update_form_config(
+    ctx,
+    app,
+    env_name,
+    org_id,
+    reset=False,
+    username_query_selector=None,
+    password_query_selector=None,
+    username_next_selector=None,
+    password_next_selector=None,
+    login_selector=None,
+    submit_selector=None,
+    **kwargs,
+):
+    _env = apps.get_env(ctx, app, env_name, org_id)
+    _app = _get_app(ctx, app, org_id=org_id)
+    if _env and _app:
+        application_configs = _env.get("application_configs", {})
+        if reset:
+            client_injection = application_configs.setdefault("client_injection", {})
+            login_config = client_injection.setdefault("login_config", {})
+            inject_form_config = login_config.setdefault("form_config", {})
+            inject_form_config["config"] = {}
+        apps.update_application_configs(
+            application_configs,
+            client_injection_login_form_username_query_selector=username_query_selector,
+            client_injection_login_form_password_query_selector=password_query_selector,
+            client_injection_login_form_username_next_selector=username_next_selector,
+            client_injection_login_form_password_next_selector=password_next_selector,
+            client_injection_login_form_login_selector=login_selector,
+            client_injection_login_form_submit_selector=submit_selector,
+            **kwargs,
+        )
+
+        apps.update_env(
+            ctx,
+            _app["id"],
+            env_name,
+            org_id,
+            application_configs=application_configs,
+        )
+
+
 @cli.command(name="list-feature-tags")
 @click.option("--name", default=None)
 @click.option("--page-at-name", default=None)
@@ -8126,6 +8284,11 @@ def add_point_of_presence(ctx, **kwargs):
 )
 @click.option("--requests-enabled", type=bool, default=None)
 @click.option("--routing-ces", default=None)
+@click.option(
+    "--overwrite-org-domains",
+    is_flag=True,
+    help="overwrites the org domains rather than adding to them",
+)
 @click.pass_context
 def update_point_of_presence(
     ctx, point_of_presence_id, add_cluster_id, remove_cluster_id, **kwargs
@@ -8340,7 +8503,18 @@ def get_connector_stats_config(ctx, **kwargs):
 @click.option("--name-slug", default=None)
 @click.option("--updated-since", default=None, type=click.DateTime())
 @click.option("--resource-id", default=None)
-@click.option("--limit", default=500)
+@click.option("--limit", type=int, default=None)
+@click.option("--get-all", is_flag=True, default=False)
+@click.option(
+    "--page-on", multiple=True, type=click.Choice(ssh.page_fields), default=None
+)
+@click.option("--page-at-key", multiple=True, type=str, default=None)
+@click.option(
+    "--page-sort", multiple=True, type=click.Choice(page_sort_order_values), default=None
+)
+@click.option(
+    "--search-direction", type=click.Choice(search_direction_values), default=None
+)
 @click.pass_context
 def list_ssh_resources(ctx, name=None, **kwargs):
     resources = ssh.list_ssh_resources(ctx, name=name, **kwargs)
@@ -8967,6 +9141,7 @@ def main():
     messages_main.add_commands(cli)
     databases.add_commands(cli)
     licensing_main.add_commands(cli)
+    deployments_main.add_commands(cli)
 
     cli(auto_envvar_prefix="AGILICUS")
 

agilicus/pagination/__init__.py

@@ -0,0 +1,3 @@
+from .input import normalize_page_args
+
+__all__ = ["normalize_page_args"]

agilicus/pagination/auto_iterator.py

@@ -0,0 +1,173 @@
+"""
+AutoIterator for paginating API client list functions.
+"""
+
+import json
+from agilicus_api.exceptions import ApiException
+
+_page_on_preference = ["name", "created", "id"]
+_default_page_on = "id"
+
+
+def get_page_on(list_function):
+    """
+    tries to figure out the pagination key to use based on the endpoint:
+     - If it's an enum, uses the preferred one in the list, otherwise the first
+     - If it's not an enum, just tries the 'default', which is id.
+    """
+    # yes, the key here is a tuple or some reason
+    result = list(list_function.allowed_values.get(("page_on",), {}).values())
+    if not result and "page_on" in list_function.params_map["all"]:
+        return [_default_page_on]
+    return result
+
+
+def _determine_page_on(list_function):
+    page_on_list = get_page_on(list_function)
+    if not page_on_list:
+        raise NotImplementedError("pagination not implemented on this endpoint")
+    for page_on in _page_on_preference:
+        if page_on in page_on_list:
+            return [page_on]
+
+    return [page_on_list[0]]
+
+
+def patch_endpoint(list_function):
+    setattr(list_function, "auto_paging_iter", AutoIteratorWrapper(list_function))
+
+
+class AutoIteratorWrapper:
+    def __init__(self, list_function):
+        self.list_function = list_function
+
+    def __call__(self, *args, limit=None, page_size=100, page_sort=None, **kwargs):
+        return AutoIterator(
+            self.list_function, limit, page_size, page_sort, *args, **kwargs
+        )
+
+
+class AutoIterator:
+    def __init__(
+        self, list_function, limit, page_size, page_sort, *args, page_on=None, **kwargs
+    ):
+        """
+        Initializes the AutoIterator.
+
+        :param list_function: The API client list function to paginate.
+        :param args: Positional arguments to pass to the list_function.
+        :param kwargs: Keyword arguments to pass to the list_function.
+        """
+        self._list_function = list_function
+        self._args = args
+        self._kwargs = kwargs
+        self.page_sort = page_sort or []
+        self.limit = limit
+        self.page_size = page_size
+        self.configured_page_on = page_on or _determine_page_on(self._list_function)
+        self._reset()
+
+    def _reset(self):
+        self._total_items = 0
+        self._page_on = self.configured_page_on
+        self._next_page = []
+        self._has_more = True
+        self._current_page_items = []
+
+    def __iter__(self):
+        """
+        Returns the iterator object itself.
+        """
+        return self
+
+    def __next__(self):
+        """
+        Fetches the next item from the paginated results.
+        """
+        if not self._current_page_items and self._has_more:
+            self._fetch_next_page()
+
+        if self._current_page_items:
+            return self._current_page_items.pop(0)
+        else:
+            raise StopIteration
+
+    def _get_page_list(self, response):
+        for key in response.attribute_map:
+            if isinstance(response.get(key), list):
+                return response.get(key)
+        return []
+
+    def _fetch_next_page(self):
+        limit = self.page_size
+        if self.limit is not None:
+            limit = min(limit, self.limit - self._total_items)
+
+        try:
+            response = self._list_function(
+                page_on=self._page_on,
+                page_at_key=self._next_page,
+                limit=limit,
+                page_sort=self.page_sort,
+                **self._kwargs,
+            )
+        except ApiException as exc:
+            if exc.status != 400:
+                raise
+
+            _handle_page_failure(exc.body)
+            # Shut up the linter, which thinks the above doesn't always throw even
+            # though it does
+            assert False
+
+        self._current_page_items = self._get_page_list(response)
+        self._total_items = self._total_items + len(self._current_page_items)
+        page_info = response.page_info
+        if (
+            not page_info
+            or not self._current_page_items
+            or (self.limit and self._total_items >= self.limit)
+        ):
+            self._has_more = False
+            return
+
+        self._next_page = page_info.page_at_key
+        self._page_on = page_info.page_on.value
+
+    # Additional functionality when interacted with as an object
+    def all(self):
+        """
+        Returns all items by iterating through all pages.
+        """
+        all_items = []
+        for item in self:
+            all_items.append(item)
+        return all_items
+
+    def first(self):
+        """
+        Returns the first item, or None if no items.
+        """
+        self._reset()
+        try:
+            return next(self)
+        except StopIteration:
+            return None
+
+    def __repr__(self):
+        return f"<AutoIterator for {self._list_function.__name__}>"
+
+
+def _handle_page_failure(body):
+    if not body:
+        raise
+    result = {}
+    try:
+        result = json.loads(body)
+    except Exception:
+        pass
+    error_message = result.get("error_message", "")
+    if "pagination key" not in error_message:
+        raise
+
+    raise NotImplementedError("Pagination not implemented on this key") from None

agilicus/pagination/input.py

@@ -0,0 +1,8 @@
+def normalize_page_args(kwargs):
+    page_sort = kwargs.get("page_sort")
+    if isinstance(page_sort, tuple):
+        kwargs["page_sort"] = list(page_sort)
+    page_on = kwargs.get("page_on")
+    if isinstance(page_on, tuple):
+        kwargs["page_on"] = list(page_on)
+    return kwargs

agilicus/patches.py

@@ -5,6 +5,8 @@ import certifi
 from .agilicus_api.api_client import ApiClient
 from .agilicus_api.configuration import Configuration
 
+from agilicus.pagination.auto_iterator import get_page_on, patch_endpoint
+
 
 class _ApiClientWrapper(ApiClient):
     def __init__(self, configuration: Configuration = None, **kwargs):
@@ -43,3 +45,18 @@ def patched_api_client():
 class _Response:
     def __init__(self, data):
         self.data = data
+
+
+def patch_endpoint_class(endpoint_class):
+    """
+    patches the Endpoint class to inject the AutoIterator into itself if needed.
+    """
+    original_init = endpoint_class.__init__
+
+    def init_wrapper(self, *args, **kwargs):
+        original_init(self, *args, **kwargs)
+        if not get_page_on(self):
+            return
+        patch_endpoint(self)
+
+    endpoint_class.__init__ = init_wrapper

agilicus/regions.py

@@ -66,6 +66,7 @@ def update_point_of_presence(
     master_cluster_id=None,
     requests_enabled=None,
     org_domain=None,
+    overwrite_org_domains=False,
     public=None,
     restrict_by_user_id=None,
     add_permitted_user_id=None,
@@ -102,6 +103,13 @@ def update_point_of_presence(
                 to_write.append(domain)
         domains = to_write
 
+    if not overwrite_org_domains:
+        to_write = original.spec.routing.org_domains
+        for domain in org_domains:
+            if domain not in to_write:
+                to_write.append(domain)
+        org_domains = to_write
+
     original.spec.routing.domains = domains
     original.spec.routing.org_domains = org_domains
     if name is not None:

agilicus/resource_helpers.py

@@ -4,6 +4,13 @@ from agilicus.agilicus_api import (
     ResourceConfig,
 )
 
+standard_page_fields = [
+    "id",
+    "name",
+    "created",
+    "org_id",
+]
+
 
 def map_resource_published(mapping, published):
     if published is not None:

agilicus/resources.py

@@ -7,7 +7,7 @@ from .input_helpers import update_org_from_input_or_ctx, strip_none
 from .create import handle_api_409
 from agilicus.output.table import make_columns
 from . import resource_helpers
-
+from .pagination import normalize_page_args
 
 from .output.table import (
     subobject_column,
@@ -19,6 +19,7 @@ from .output.table import (
 )
 import agilicus
 
+
 permissioned_resource_types = [
     "application",
     "fileshare",
@@ -33,6 +34,10 @@ resource_types = permissioned_resource_types + ["service_forwarder"]
 permissioned_resource_type_enum = click.Choice(permissioned_resource_types)
 resource_type_enum = click.Choice(resource_types)
 
+resource_page_fields = resource_helpers.standard_page_fields + [
+    "resource_type",
+]
+
 
 def query_permissions(ctx, org_id=None, **kwargs):
     org_id = get_org_from_input_or_ctx(ctx, org_id=org_id)
@@ -108,17 +113,21 @@ def bulk_delete_permission(ctx, **kwargs):
     )
 
 
-def query_resources(ctx, org_id=None, **kwargs):
+def query_resources(ctx, org_id=None, get_all=False, limit=None, **kwargs):
     org_id = get_org_from_input_or_ctx(ctx, org_id=org_id)
     token = context.get_token(ctx)
     apiclient = context.get_apiclient(ctx, token)
     kwargs["org_id"] = org_id
     params = {}
     update_if_not_none(params, kwargs)
-    query_results = apiclient.resources_api.list_resources(**params)
-    if query_results:
-        return query_results.resources
-    return []
+    params = normalize_page_args(params)
+    if not get_all:
+        if limit is None:
+            limit = 500
+        return apiclient.resources_api.list_resources(limit=limit, **params).resources
+    return apiclient.resources_api.list_resources.auto_paging_iter(
+        limit=limit, **params
+    ).all()
 
 
 def format_resources(ctx, resources, show_columns=None, reset_columns=None):

agilicus/ssh.py

@@ -15,15 +15,29 @@ from .output.table import (
     format_table,
     metadata_column,
 )
-from .resource_helpers import map_resource_published
+from .pagination import normalize_page_args
+from .resource_helpers import map_resource_published, standard_page_fields
 
+page_fields = standard_page_fields
 
-def list_ssh_resources(ctx, **kwargs):
+
+def list_ssh_resources(ctx, get_all=False, limit=None, **kwargs):
     apiclient = context.get_apiclient_from_ctx(ctx)
     update_org_from_input_or_ctx(kwargs, ctx, **kwargs)
     params = strip_none(kwargs)
-    query_results = apiclient.app_services_api.list_ssh_resources(**params)
-    return query_results.ssh_resources
+    params = normalize_page_args(params)
+    if not get_all:
+        if limit is None:
+            limit = 500
+        return apiclient.app_services_api.list_ssh_resources(
+            limit=limit, **params
+        ).ssh_resources
+    return [
+        x
+        for x in apiclient.app_services_api.list_ssh_resources.auto_paging_iter(
+            limit=limit, **params
+        )
+    ]
 
 
 def add_ssh_resource(ctx, port, **kwargs):