orchestrator-shell 0.1.0__py3-none-any.whl

orchestrator_shell-0.1.0.dist-info/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+   Copyright [yyyy] [name of copyright owner]
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2024] [Workflow Orchestrator Project]
+
+   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.

orchestrator_shell-0.1.0.dist-info/METADATA

@@ -0,0 +1,36 @@
+Metadata-Version: 2.3
+Name: orchestrator-shell
+Version: 0.1.0
+Summary: Shell for interacting with an orchestrator-core database.
+Requires-Python: >=3.11,<3.14
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Dist: cmd2
+Requires-Dist: orchestrator-core
+Requires-Dist: tabulate
+Requires-Dist: mypy ; extra == "dev"
+Requires-Dist: ruff ; extra == "dev"
+Requires-Dist: types-tabulate ; extra == "dev"
+Requires-Dist: bumpversion ; extra == "dev"
+Project-URL: Documentation, https://workfloworchestrator.org/orchestrator-core/
+Project-URL: Source, https://github.com/workfloworchestrator/wfoshell
+Provides-Extra: dev

orchestrator_shell-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+wfoshell/__init__.py,sha256=jELakGRhZNRoPojr_U7yhSxxnl_IHKDeTjuv4WY2opY,666
+wfoshell/__main__.py,sha256=fiFxm7coqdAmwzPXxSpKhT35yTLVtCtkFpvoLznBb_k,15449
+wfoshell/product_block.py,sha256=YsPb9gPrQj2pmU2rZrYBsG-jKPIQb4rcbCiC69X2sOQ,5455
+wfoshell/resource_type.py,sha256=A6JbrFHRZQRscUKCUFyBCd5YnR9-O_GBKXOXw7Qim5w,3221
+wfoshell/settings.py,sha256=iDnQvOBQtb1SCxnTq052CtZqEPc2nThZnNtt5sLcmhI,999
+wfoshell/state.py,sha256=53A7t9I4NiFkmP1tKbkdXYqWuRv-vlKtWdZE_YmsWrw,6312
+wfoshell/subscripition.py,sha256=0lbcNgqwQPpOv7YNEJJkbxEe5ggEoaQtOGCsb4MD554,4583
+orchestrator_shell-0.1.0.dist-info/LICENSE,sha256=mArBeJXIz9xnP96SRvhrKyjGFnJDg9Eu0SbLyUiKRHk,11408
+orchestrator_shell-0.1.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
+orchestrator_shell-0.1.0.dist-info/METADATA,sha256=bh0DIURYzfgcEGMk642o5POepMEutOtMIMdY4UAdyX0,1616
+orchestrator_shell-0.1.0.dist-info/RECORD,,

orchestrator_shell-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: flit 3.10.1
+Root-Is-Purelib: true
+Tag: py3-none-any

wfoshell/__init__.py

@@ -0,0 +1,15 @@
+#  Copyright 2024 SURF.
+#  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.
+"""Shell for interacting with an orchestrator-core database."""
+
+__version__ = "0.1.0"

wfoshell/__main__.py

@@ -0,0 +1,313 @@
+#  Copyright 2024 SURF.
+#  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.
+
+from argparse import Namespace
+from datetime import datetime
+
+from cmd2 import Cmd, Cmd2ArgumentParser, Statement, with_argparser
+from orchestrator.db import init_database
+
+import wfoshell.product_block
+import wfoshell.resource_type
+import wfoshell.state
+import wfoshell.subscripition
+from wfoshell.settings import settings
+from wfoshell.state import state
+
+
+class WFOshell(Cmd):
+    """WorkFlow Orchestrator shell."""
+
+    intro = "Welcome to the WFO shell.\n" "Type help or ? to list commands."
+
+    def __init__(self) -> None:
+        """WFO shell initialisation."""
+        super().__init__(
+            persistent_history_file=str(settings.WFOSHELL_HISTFILE),
+            persistent_history_length=settings.WFOSHELL_HISTFILE_SIZE,
+        )
+        self.prompt = "(wfo) "
+        self.hidden_commands.extend(["alias", "edit", "macro", "run_pyscript", "run_script", "shell", "shortcuts"])
+        init_database(settings)  # type: ignore[arg-type]
+
+    def do_exit(self, line: Statement) -> bool:  # noqa: ARG002
+        """Exit the application."""
+        return True
+
+    # subcommand functions for the subscription command
+    def subscription_list(self, args: Namespace) -> None:  # noqa: ARG002
+        """List subcommand of subscription command."""
+        self.poutput(wfoshell.subscripition.subscription_list())
+
+    def subscription_search(self, args: Namespace) -> None:
+        """Search subcommand of subscription command."""
+        self.poutput(wfoshell.subscripition.subscription_search(args.regular_expression))
+
+    def subscription_select(self, args: Namespace) -> None:
+        """Select subcommand of subscription command."""
+        number_of_subscriptions = (
+            len(state.filtered_subscriptions) if state.filtered_subscriptions is not None else len(state.subscriptions)
+        )
+        if not number_of_subscriptions:
+            self.pwarning("list or search for subscriptions first")
+        elif not 0 <= args.index < number_of_subscriptions:
+            self.pwarning(f"selected subscription index not between 0 and {number_of_subscriptions - 1}")
+        else:
+            self.poutput(wfoshell.subscripition.subscription_select(args.index))
+
+    def subscription_details(self, args: Namespace) -> None:
+        """Details subcommand of subscription command."""
+        if state.subscription_index is None:
+            self.pwarning("first select a subscription")
+        else:
+            self.poutput(
+                wfoshell.subscripition.subscription_details(
+                    subscription_only=args.subscription_only, product_blocks_only=args.product_blocks_only
+                )
+            )
+
+    def subscription_update(self, args: Namespace) -> None:  # noqa: C901
+        """Update subcommand of subscription command."""
+        if state.subscription_index is None:
+            self.pwarning("first select a subscription")
+            return
+        if args.field in ["insync"]:
+            if args.new_value.lower() in ["y", "yes", "true"]:
+                args.new_value = True
+            elif args.new_value.lower() in ["n", "no", "false"]:
+                args.new_value = False
+            else:
+                self.pwarning("expected y, yes, true, n, no or false")
+                return
+        if args.field in ["start_date", "end_date"]:
+            if args.new_value == "":
+                args.new_value = None
+            else:
+                try:
+                    args.new_value = datetime.fromisoformat(args.new_value)
+                except ValueError as value_error:
+                    self.pwarning(str(value_error))
+                    return
+                if args.new_value.tzinfo is None:
+                    args.new_value = args.new_value.astimezone()
+        wfoshell.subscripition.subscription_update(args.field, args.new_value)
+
+    # subscription (sub)commands argument parsers
+    s_parser = Cmd2ArgumentParser()
+    s_subparser = s_parser.add_subparsers(title="subscription subcommands")
+    s_list_parser = s_subparser.add_parser("list", help="list all subscriptions from database")
+    s_list_parser.set_defaults(func=subscription_list)
+    s_search_parser = s_subparser.add_parser("search", help="case insensitive search subscription descriptions")
+    s_search_parser.add_argument("regular_expression", type=str, help="match description on regular expression")
+    s_search_parser.set_defaults(func=subscription_search)
+    s_select_parser = s_subparser.add_parser("select", help="select subscription to work on")
+    s_select_parser.add_argument("index", type=int, help="select by index number")
+    s_select_parser.set_defaults(func=subscription_select)
+    s_details_parser = s_subparser.add_parser("details", help="show subscription details")
+    s_details_parser.add_argument("--subscription_only", action="store_true", help="show subscription details only")
+    s_details_parser.add_argument("--product_blocks_only", action="store_true", help="show product block details only")
+    s_details_parser.set_defaults(func=subscription_details)
+    s_update_parser = s_subparser.add_parser("update", help="update subscription field")
+    s_update_parser.add_argument(
+        "field",
+        choices=[
+            "description",
+            "status",
+            "customer_id",
+            "insync",
+            "start_date",
+            "end_date",
+            "note",
+        ],
+        help="subscription field",
+    )
+    s_update_parser.add_argument("new_value", type=str, help="new value for selected subscription field")
+    s_update_parser.set_defaults(func=subscription_update)
+
+    # subscription command
+    @with_argparser(s_parser)
+    def do_subscription(self, args: Namespace) -> None:
+        """List, search or select subscriptions, update fields, and show details."""
+        if func := getattr(args, "func", None):
+            func(self, args)
+        else:
+            self.do_help("subscription")
+
+    # subcommand functions for the product_block command
+    def product_block_list(self, args: Namespace) -> None:  # noqa: ARG002
+        """List subcommand of product_block command."""
+        if state.subscription_index is None:
+            self.pwarning("first select a subscription")
+        else:
+            self.poutput(wfoshell.product_block.product_block_list())
+
+    def product_block_select(self, args: Namespace) -> None:
+        """Select subcommand of product_block command."""
+        if not (number_of_product_blocks := len(state.selected_product_blocks)):
+            self.pwarning("list or search for product_blocks first")
+        elif not 0 <= args.index < number_of_product_blocks:
+            self.pwarning(f"selected product_block index not between 0 and {number_of_product_blocks - 1}")
+        else:
+            self.poutput(wfoshell.product_block.product_block_select(args.index))
+
+    def product_block_details(self, args: Namespace) -> None:
+        """Details subcommand of product_block command."""
+        if state.product_block_index is None:
+            self.pwarning("first select a product_block")
+        else:
+            self.poutput(
+                wfoshell.product_block.product_block_details(
+                    product_block_only=args.product_block_only,
+                    resource_types_only=args.resource_types_only,
+                    depends_on_only=args.depends_on_only,
+                    in_use_by_only=args.in_use_by_only,
+                )
+            )
+
+    def product_block_depends_on(self, args: Namespace) -> None:
+        """Depends_on subcommand of product_block command."""
+        if state.product_block_index is None:
+            self.pwarning("first select a product block")
+        elif not (number_of_depends_on := len(state.selected_product_block.depends_on)):
+            self.pwarning("no depend on product blocks")
+        elif not 0 <= args.index < number_of_depends_on:
+            self.pwarning(f"selected product_block index not between 0 and {number_of_depends_on - 1}")
+        else:
+            self.poutput(wfoshell.product_block.product_block_depends_on(args.index))
+
+    def product_block_in_use_by(self, args: Namespace) -> None:
+        """In_use_by subcommand of product_block command."""
+        if state.product_block_index is None:
+            self.pwarning("first select a product block")
+        elif not (number_of_in_use_by := len(state.selected_product_block.in_use_by)):
+            self.pwarning("no in use by product blocks")
+        elif not 0 <= args.index < number_of_in_use_by:
+            self.pwarning(f"selected product_block index not between 0 and {number_of_in_use_by - 1}")
+        else:
+            self.poutput(wfoshell.product_block.product_block_in_use_by(args.index))
+
+    # product_block (sub)commands argument parsers
+    pb_parser = Cmd2ArgumentParser()
+    pb_subparser = pb_parser.add_subparsers(title="product_block subcommands")
+    pb_list_parser = pb_subparser.add_parser("list", help="list product blocks of current selected subscription")
+    pb_list_parser.set_defaults(func=product_block_list)
+    pb_select_parser = pb_subparser.add_parser("select", help="select product block to work on")
+    pb_select_parser.add_argument("index", type=int, help="select by index number")
+    pb_select_parser.set_defaults(func=product_block_select)
+    pb_details_parser = pb_subparser.add_parser("details", help="show product block details")
+    pb_details_parser.add_argument("--product_block_only", action="store_true", help="show product block details only")
+    pb_details_parser.add_argument("--resource_types_only", action="store_true", help="show resource type details only")
+    pb_details_parser.add_argument("--depends_on_only", action="store_true", help="show depends on details only")
+    pb_details_parser.add_argument("--in_use_by_only", action="store_true", help="show in use by details only")
+    pb_details_parser.set_defaults(func=product_block_details)
+    pb_depends_on_parser = pb_subparser.add_parser("depends_on", help="show depends on product blocks")
+    pb_depends_on_parser.add_argument("index", type=int, help="select by index number")
+    pb_depends_on_parser.set_defaults(func=product_block_depends_on)
+    pb_is_use_by_parser = pb_subparser.add_parser("in_use_by", help="show in use by product blocks")
+    pb_is_use_by_parser.add_argument("index", type=int, help="select by index number")
+    pb_is_use_by_parser.set_defaults(func=product_block_in_use_by)
+
+    # product_block command
+    @with_argparser(pb_parser)
+    def do_product_block(self, args: Namespace) -> None:
+        """List and select product blocks, show details, or follow depends on and in use by product blocks."""
+        if func := getattr(args, "func", None):
+            func(self, args)
+        else:
+            self.do_help("product_block")
+
+    # subcommand functions for the resource_type command
+    def resource_type_list(self, args: Namespace) -> None:  # noqa: ARG002
+        """List subcommand of resource_type command."""
+        if state.product_block_index is None:
+            self.pwarning("first select a product block")
+        else:
+            self.poutput(wfoshell.resource_type.resource_type_list())
+
+    def resource_type_select(self, args: Namespace) -> None:
+        """Select subcommand of resource_type command."""
+        if not (number_of_resource_types := len(state.selected_resource_types)):
+            self.pwarning("list or search for resource_types first")
+        elif not 0 <= args.index < number_of_resource_types:
+            self.pwarning(f"selected resource_type index not between 0 and {number_of_resource_types - 1}")
+        else:
+            self.poutput(wfoshell.resource_type.resource_type_select(args.index))
+
+    def resource_type_details(self, args: Namespace) -> None:  # noqa: ARG002
+        """Details subcommand of resource_type command."""
+        if state.resource_type_index is None:
+            self.pwarning("first select a resource_type")
+        else:
+            self.poutput(wfoshell.resource_type.resource_type_details())
+
+    def resource_type_update(self, args: Namespace) -> None:
+        """Update subcommand of resource_type command."""
+        if state.resource_type_index is None:
+            self.pwarning("first select a resource_type")
+        else:
+            wfoshell.resource_type.resource_type_update(args.new_value)
+
+    # resource_type (sub)commands argument parsers
+    rt_parser = Cmd2ArgumentParser()
+    rt_subparser = rt_parser.add_subparsers(title="resource_type subcommands")
+    rt_list_parser = rt_subparser.add_parser("list", help="list resource types of current selected product block")
+    rt_list_parser.set_defaults(func=resource_type_list)
+    rt_select_parser = rt_subparser.add_parser("select", help="select resource type to work on")
+    rt_select_parser.add_argument("index", type=int, help="select by index number")
+    rt_select_parser.set_defaults(func=resource_type_select)
+    rt_details_parser = rt_subparser.add_parser("details", help="show resource type details")
+    rt_details_parser.set_defaults(func=resource_type_details)
+    rt_update_parser = rt_subparser.add_parser("update", help="update selected resource type")
+    rt_update_parser.add_argument("new_value", type=str, help="new value for selected resource type")
+    rt_update_parser.set_defaults(func=resource_type_update)
+
+    # resource_type command
+    @with_argparser(rt_parser)
+    def do_resource_type(self, args: Namespace) -> None:
+        """List, select and update resource types, and show details."""
+        if func := getattr(args, "func", None):
+            func(self, args)
+        else:
+            self.do_help("resource_type")
+
+    # subcommand functions for the state command
+    def state_summary(self, args: Namespace) -> None:  # noqa: ARG002
+        """summary subcommand of state command."""
+        if summary := state.summary:
+            self.poutput(summary)
+
+    def state_details(self, args: Namespace) -> None:  # noqa: ARG002
+        """details subcommand of state command."""
+        self.poutput(state.details)
+
+    # state (sub)commands argument parsers
+    state_parser = Cmd2ArgumentParser()
+    state_subparser = state_parser.add_subparsers(title="state subcommands")
+    state_summary_parser = state_subparser.add_parser("summary", help="show state summary")
+    state_summary_parser.set_defaults(func=state_summary)
+    state_details_parser = state_subparser.add_parser("details", help="show state details")
+    state_details_parser.set_defaults(func=state_details)
+
+    # resource_type command
+    @with_argparser(state_parser)
+    def do_state(self, args: Namespace) -> None:
+        """Show state summary or details."""
+        if func := getattr(args, "func", None):
+            func(self, args)
+        else:
+            self.do_help("state")
+
+
+if __name__ == "__main__":
+    shell = WFOshell()
+    shell.cmdloop()

wfoshell/product_block.py

@@ -0,0 +1,131 @@
+#  Copyright 2024 SURF.
+#  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.
+
+
+from orchestrator.db import SubscriptionInstanceTable
+from tabulate import tabulate
+
+from wfoshell.resource_type import resource_type_table
+from wfoshell.state import all_resource_types, state
+
+
+def product_block_table(product_blocks: list[SubscriptionInstanceTable]) -> str:
+    """Return indexed table of product blocks."""
+    max_rt_width = max([len(rt.resource_type.resource_type) for pb in product_blocks for rt in all_resource_types(pb)])
+    return tabulate(
+        [
+            [
+                tabulate(
+                    [
+                        ["name", product_block.product_block.name],
+                        ["resource types", resource_type_table(all_resource_types(product_block), max_rt_width)],
+                    ],
+                    tablefmt="plain",
+                )
+            ]
+            for product_block in product_blocks
+        ],
+        tablefmt="plain",
+        disable_numparse=True,
+        showindex=True,
+    )
+
+
+def details_product_block(product_block: SubscriptionInstanceTable) -> list[tuple[str, str]]:
+    """Return list of tuples with product block details only."""
+    return [
+        ("name", product_block.product_block.name),
+        ("subscription_instance_id", product_block.subscription_instance_id),
+        ("subscription_id", product_block.subscription_id),
+        ("product_block_id", product_block.product_block_id),
+        ("label", product_block.label),
+    ]
+
+
+def details_resource_types(product_block: SubscriptionInstanceTable) -> list[tuple[str, str]]:
+    """Return list of tuples with resource type details only."""
+    return [
+        ("resource types", resource_type_table(all_resource_types(product_block))),
+    ]
+
+
+def details_depends_on(product_block: SubscriptionInstanceTable) -> list[tuple[str, str]]:
+    """Return list of tuples with depends on details only."""
+    return [
+        ("depends_on", product_block_table(product_block.depends_on) if product_block.depends_on else ""),
+    ]
+
+
+def details_in_use_by(product_block: SubscriptionInstanceTable) -> list[tuple[str, str]]:
+    """Return list of tuples with in use by details only."""
+    return [
+        ("in_use_by", product_block_table(product_block.in_use_by) if product_block.in_use_by else ""),
+    ]
+
+
+def details_all(product_block: SubscriptionInstanceTable) -> list[tuple[str, str]]:
+    """Return list of tuples with all product block details."""
+    return (
+        details_product_block(product_block)
+        + details_resource_types(product_block)
+        + details_depends_on(product_block)
+        + details_in_use_by(product_block)
+    )
+
+
+def product_block_list() -> str:
+    """Implementation of the 'product_block list' subcommand."""
+    return product_block_table(state.selected_product_blocks)
+
+
+def product_block_select(index: int) -> str:
+    """Implementation of the 'product_block select' subcommand."""
+    state.product_block_index = index
+    state.resource_type_index = None
+    return state.summary
+
+
+def product_block_details(
+    product_block_only: bool, resource_types_only: bool, depends_on_only: bool, in_use_by_only: bool
+) -> str:
+    """Implementation of the 'product_block details' subcommand."""
+    if product_block_only:
+        return tabulate(details_product_block(state.selected_product_block), tablefmt="plain")
+    elif resource_types_only:  # noqa: RET505
+        return tabulate(details_resource_types(state.selected_product_block), tablefmt="plain")
+    elif depends_on_only:
+        return tabulate(details_depends_on(state.selected_product_block), tablefmt="plain")
+    elif in_use_by_only:
+        return tabulate(details_in_use_by(state.selected_product_block), tablefmt="plain")
+    else:
+        return tabulate(details_all(state.selected_product_block), tablefmt="plain")
+
+
+def product_block_depends_on(index: int) -> str:
+    """Implementation of the 'product_block depends_on' subcommand."""
+    depends_on_product_block = state.selected_product_block.depends_on[index]
+    state.subscription_index = state.subscriptions.index(depends_on_product_block.subscription)
+    # note that the selected_product_blocks list below is of the subscription selected just above
+    state.product_block_index = state.selected_product_blocks.index(depends_on_product_block)
+    state.resource_type_index = None
+    return state.summary
+
+
+def product_block_in_use_by(index: int) -> str:
+    """Implementation of the 'product_block in_use_by' subcommand."""
+    in_use_by_product_block = state.selected_product_block.in_use_by[index]
+    state.subscription_index = state.subscriptions.index(in_use_by_product_block.subscription)
+    # note that the selected_product_blocks list below is of the subscription selected just above
+    state.product_block_index = state.selected_product_blocks.index(in_use_by_product_block)
+    state.resource_type_index = None
+    return state.summary

wfoshell/resource_type.py

@@ -0,0 +1,82 @@
+#  Copyright 2024 SURF.
+#  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.
+
+
+import tabulate
+from orchestrator.db import SubscriptionInstanceValueTable, db, transactional
+from structlog import get_logger
+
+from wfoshell.state import sorted_resource_types, state
+
+logger = get_logger(__name__)
+tabulate.PRESERVE_WHITESPACE = True
+
+
+def resource_type_table(resource_types: list[SubscriptionInstanceValueTable], width: int = 0) -> str:
+    """Return indexed table of resource types, with name optionally aligned on width."""
+    return tabulate.tabulate(
+        [
+            [
+                resource_type.resource_type.resource_type.ljust(width),
+                resource_type.value if resource_type.value is not None else "<unset or non-scalar>",
+            ]
+            for resource_type in sorted_resource_types(resource_types)
+        ],
+        tablefmt="plain",
+        disable_numparse=True,
+        showindex=True,
+    )
+
+
+def details(resource_type: SubscriptionInstanceValueTable | None) -> list[tuple[str, str]]:
+    """Return list of tuples with resource type detail information."""
+    if resource_type is None:
+        return []
+    return [
+        ("resource_type", resource_type.resource_type.resource_type),
+        ("value", resource_type.value),
+        ("subscription_instance_value_id", resource_type.subscription_instance_value_id),
+        ("subscription_instance_id", resource_type.subscription_instance_id),
+        ("resource_type_id", resource_type.resource_type_id),
+    ]
+
+
+def resource_type_list() -> str:
+    """Implementation of the 'resource_type list' subcommand."""
+    return resource_type_table(state.selected_resource_types)
+
+
+def resource_type_select(index: int) -> str:
+    """Implementation of the 'resource_type select' subcommand."""
+    state.resource_type_index = index
+    return state.summary
+
+
+def resource_type_details() -> str:
+    """Implementation of the 'resource_type details' subcommand."""
+    return tabulate.tabulate(details(state.selected_resource_type), tablefmt="plain")
+
+
+def resource_type_update(new_value: str) -> None:
+    """Implementation of the 'resource_type update' subcommand."""
+    with transactional(db, logger):
+        if state.selected_resource_type.value is None:
+            # add previously unset resource type to list of product block values
+            state.selected_product_block.values.append(
+                SubscriptionInstanceValueTable(
+                    resource_type_id=state.selected_resource_type.resource_type.resource_type_id, value=new_value
+                )
+            )
+        else:
+            # otherwise just update the existing resource type value
+            state.selected_resource_type.value = new_value

wfoshell/settings.py

@@ -0,0 +1,28 @@
+#  Copyright 2024 SURF.
+#  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.
+
+from pathlib import Path
+
+from pydantic.networks import PostgresDsn
+from pydantic_settings import BaseSettings
+
+
+class Settings(BaseSettings):
+    """WFO Shell settings."""
+
+    DATABASE_URI: PostgresDsn = "postgresql://nwa:nwa@localhost/orchestrator-core"  # type: ignore[assignment]
+    WFOSHELL_HISTFILE: Path = Path("~/.wfoshell_history").expanduser()
+    WFOSHELL_HISTFILE_SIZE: int = 1000
+
+
+settings = Settings()

wfoshell/state.py

@@ -0,0 +1,153 @@
+#  Copyright 2024 SURF.
+#  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.
+
+from dataclasses import dataclass, field
+
+from orchestrator.db import SubscriptionInstanceTable, SubscriptionInstanceValueTable, SubscriptionTable
+from tabulate import tabulate
+
+
+@dataclass
+class State:
+    """State that is shared between the WFO shell commands."""
+
+    subscriptions: list[SubscriptionTable] = field(default_factory=list)
+    filtered_subscriptions: list[SubscriptionTable] | None = None
+    subscription_index: int | None = None
+    product_block_index: int | None = None
+    resource_type_index: int | None = None
+
+    @property
+    def selected_subscription(self) -> SubscriptionTable:
+        """Return the subscription indexed by subscription_index."""
+        if self.subscription_index is not None:
+            return self.subscriptions[self.subscription_index]
+        raise IndexError("subscription_index not set")
+
+    @property
+    def selected_product_blocks(self) -> list[SubscriptionInstanceTable]:
+        """Return sorted list of product blocks for the subscription indexed by subscription_index."""
+        return (
+            (sorted_product_blocks(self.selected_subscription.instances)) if self.subscription_index is not None else []
+        )
+
+    @property
+    def selected_product_block(self) -> SubscriptionInstanceTable:
+        """Return the product block indexed by product_block_index."""
+        if self.product_block_index is not None:
+            return self.selected_product_blocks[self.product_block_index]
+        raise IndexError("product_block_index not set")
+
+    @property
+    def selected_resource_types(self) -> list[SubscriptionInstanceValueTable]:
+        """Return sorted list of resource types for the product block indexed by product_block_index."""
+        return (
+            sorted_resource_types(all_resource_types(self.selected_product_block))
+            if self.product_block_index is not None
+            else []
+        )
+
+    @property
+    def selected_resource_type(self) -> SubscriptionInstanceValueTable:
+        """Return the resource type indexed by resource_type_index."""
+        if self.resource_type_index is not None:
+            return self.selected_resource_types[self.resource_type_index]
+        raise IndexError("resource_type_index not set")
+
+    @property
+    def summary(self) -> str:
+        """List summary of the selected subscription, product block and resource type."""
+        summary = []
+        if self.subscription_index is not None:
+            summary.append(
+                (
+                    "subscription",
+                    self.selected_subscription.description,
+                    self.selected_subscription.subscription_id,
+                )
+            )
+        if self.product_block_index is not None:
+            summary.append(
+                (
+                    "product block",
+                    self.selected_product_block.product_block.name,
+                    self.selected_product_block.subscription_instance_id,
+                ),
+            )
+        if self.resource_type_index is not None:
+            rt = self.selected_resource_type
+            summary.append(
+                (
+                    "resource_type",
+                    rt.resource_type.resource_type,
+                    rt.subscription_instance_value_id if rt.value is not None else "<unset or non-scalar>",
+                ),
+            )
+        return tabulate(summary, tablefmt="plain")
+
+    @property
+    def details(self) -> str:
+        """Show state details."""
+        return tabulate(
+            [
+                ("number of subscriptions", len(self.subscriptions)),
+                (
+                    "number of filtered subscriptions",
+                    len(self.filtered_subscriptions) if self.filtered_subscriptions is not None else "0",
+                ),
+                ("subscription index", self.subscription_index if self.subscription_index is not None else "unset"),
+                ("product block index", self.product_block_index if self.subscription_index is not None else "unset"),
+                ("resource type index", self.resource_type_index if self.subscription_index is not None else "unset"),
+                ("currently selected", self.summary),
+            ],
+            tablefmt="plain",
+        )
+
+
+state = State()
+
+
+def all_resource_types(product_block: SubscriptionInstanceTable) -> list[SubscriptionInstanceValueTable]:
+    """Add optional unset resource type(s) with value None to list of already set resource types."""
+    return list(
+        (
+            {
+                rt.resource_type: SubscriptionInstanceValueTable(
+                    resource_type_id=rt.resource_type_id, resource_type=rt, value=None
+                )
+                for rt in product_block.product_block.resource_types
+            }
+            | {v.resource_type.resource_type: v for v in product_block.values}
+        ).values()
+    )
+
+
+def sorted_subscriptions(subscriptions: list[SubscriptionTable]) -> list[SubscriptionTable]:
+    """Sort subscriptions on description."""
+    return sorted(subscriptions, key=lambda subscription: subscription.description)
+
+
+def sorted_product_blocks(product_blocks: list[SubscriptionInstanceTable]) -> list[SubscriptionInstanceTable]:
+    """Sort product blocks on product block name."""
+    return sorted(
+        product_blocks,
+        key=lambda subscription_instance: subscription_instance.product_block.name,
+    )
+
+
+def sorted_resource_types(resource_types: list[SubscriptionInstanceValueTable]) -> list[SubscriptionInstanceValueTable]:
+    """Sort resource types on resource type name."""
+    return sorted(
+        resource_types,
+        key=lambda subscription_instance_value: subscription_instance_value.resource_type.resource_type,
+    )

wfoshell/subscripition.py

@@ -0,0 +1,113 @@
+#  Copyright 2024 SURF.
+#  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.
+
+import re
+from datetime import datetime
+
+from orchestrator.db import SubscriptionTable, db, transactional
+from structlog import get_logger
+from tabulate import tabulate
+
+from wfoshell.product_block import product_block_table
+from wfoshell.state import sorted_subscriptions, state
+
+logger = get_logger(__name__)
+
+
+def indexed_subscription_list(subscriptions: list[SubscriptionTable]) -> str:
+    """Return tabulated indexed list of subscriptions."""
+    return tabulate(
+        [(subscription.description, subscription.subscription_id) for subscription in subscriptions],
+        tablefmt="plain",
+        disable_numparse=True,
+        showindex=True,
+    )
+
+
+def query_db() -> list[SubscriptionTable]:
+    """Return sorted and list of subscriptions from the database."""
+    return sorted_subscriptions(SubscriptionTable.query.all())
+
+
+def filtered_subscriptions(regular_expression: str, subscriptions: list[SubscriptionTable]) -> list[SubscriptionTable]:
+    """Return filtered list of subscriptions."""
+    pattern = re.compile(regular_expression, flags=re.IGNORECASE)
+    return list(filter(lambda subscription: pattern.search(subscription.description), subscriptions))
+
+
+def details_subscription_only(subscription: SubscriptionTable) -> list[tuple[str, str]]:
+    """Return list of tuples with subscription details only."""
+    return [
+        ("description", subscription.description),
+        ("subscription_id", subscription.subscription_id),
+        ("status", subscription.status),
+        ("product_id", subscription.product_id),
+        ("customer_id", subscription.customer_id),
+        ("insync", subscription.insync),
+        ("start_date", subscription.start_date),
+        ("end_date", subscription.end_date),
+        ("note", subscription.note),
+    ]
+
+
+def details_product_blocks_only() -> list[tuple[str, str]]:
+    """Return list of tuples with product blocks details only."""
+    return [
+        ("product block(s)", product_block_table(state.selected_product_blocks)),
+    ]
+
+
+def details_all(subscription: SubscriptionTable) -> list[tuple[str, str]]:
+    """Return list of tuples with all subscription details."""
+    return details_subscription_only(subscription) + details_product_blocks_only()
+
+
+def subscription_list() -> str:
+    """Add list of all subscriptions to the state and return this list tabulated and indexed."""
+    state.subscriptions = query_db()
+    state.filtered_subscriptions = None
+    return indexed_subscription_list(state.subscriptions)
+
+
+def subscription_search(regular_expression: str) -> str:
+    """Add list of filtered subscriptions to the state and return this list tabulated and indexed."""
+    state.subscriptions = query_db()
+    state.filtered_subscriptions = filtered_subscriptions(regular_expression, state.subscriptions)
+    return indexed_subscription_list(state.filtered_subscriptions)
+
+
+def subscription_select(index: int) -> str:
+    """Implementation of the 'subscription select' subcommand."""
+    if state.filtered_subscriptions is None:
+        state.subscription_index = index
+    else:
+        state.subscription_index = state.subscriptions.index(state.filtered_subscriptions[index])
+    state.product_block_index = None
+    state.resource_type_index = None
+    return state.summary
+
+
+def subscription_details(subscription_only: bool, product_blocks_only: bool) -> str:
+    """Implementation of the 'subscription details' subcommand."""
+    if subscription_only:
+        return tabulate(details_subscription_only(state.selected_subscription), tablefmt="plain")
+    elif product_blocks_only:  # noqa: RET505
+        return tabulate(details_product_blocks_only(), tablefmt="plain")
+    else:
+        return tabulate(details_all(state.selected_subscription), tablefmt="plain")
+
+
+def subscription_update(field: str, new_value: str | bool | datetime | None) -> None:
+    """Implementation of the 'subscription update' subcommand."""
+    with transactional(db, logger):
+        setattr(state.selected_subscription, field, new_value)