myfaasmctl 0.0.1__tar.gz

myfaasmctl-0.0.1/LICENSE.md

@@ -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 "[]"
+      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 2023 - Faasm Team
+
+   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.
+

myfaasmctl-0.0.1/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.1
+Name: myfaasmctl
+Version: 0.0.1
+Summary: Command line tool to deploy, manage, and interact with Faasm
+Author-email: Faasm Team <foo@bar.com>
+Project-URL: Homepage, https://github.com/faasm/faasmctl
+Project-URL: Bug Tracker, https://github.com/faasm/faasmctl/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: invoke==2.1.3
+Requires-Dist: requests==2.31.0
+Requires-Dist: protobuf==4.23.4
+
+# Faasm CTL [![Tests](https://github.com/faasm/faasmctl/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/faasm/faasmctl/actions/workflows/tests.yml) ![PyPI](https://img.shields.io/pypi/v/faasmctl)
+
+`faasmctl` is a command line script to deploy, manage, and interact with a
+running [Faasm](https://github.com/faasm/faasm) cluster.
+
+## Install
+
+To install `faasmctl` you need a working `pip` (virtual-)environment. Then:
+
+```bash
+pip install faasmctl==0.43.0
+```
+
+## Usage
+
+`faasmctl` aggregates tasks related to deploying, managing, and interacting
+with running Faasm clusters. You can list all the available tasks with a
+short description using:
+
+```bash
+faasmctl -l
+```
+
+## Further Reading
+
+For any further reading, check the [`docs`](./docs) directory.

myfaasmctl-0.0.1/README.md

@@ -0,0 +1,26 @@
+# Faasm CTL [![Tests](https://github.com/faasm/faasmctl/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/faasm/faasmctl/actions/workflows/tests.yml) ![PyPI](https://img.shields.io/pypi/v/faasmctl)
+
+`faasmctl` is a command line script to deploy, manage, and interact with a
+running [Faasm](https://github.com/faasm/faasm) cluster.
+
+## Install
+
+To install `faasmctl` you need a working `pip` (virtual-)environment. Then:
+
+```bash
+pip install faasmctl==0.43.0
+```
+
+## Usage
+
+`faasmctl` aggregates tasks related to deploying, managing, and interacting
+with running Faasm clusters. You can list all the available tasks with a
+short description using:
+
+```bash
+faasmctl -l
+```
+
+## Further Reading
+
+For any further reading, check the [`docs`](./docs) directory.

myfaasmctl-0.0.1/faasmctl/__init__.py

@@ -0,0 +1,4 @@
+# flake8: noqa
+
+from . import tasks
+from . import util

myfaasmctl-0.0.1/faasmctl/bin/gen_proto_files.py

@@ -0,0 +1,110 @@
+#!/usr/bin/env python3
+
+from os import environ, listdir, makedirs
+from os.path import dirname, exists, join, realpath
+from shutil import rmtree
+from sys import argv
+from subprocess import run
+
+FAASMCTL_ROOT = dirname(dirname(realpath(__file__)))
+
+# Unfortunately, we need to duplicate this constants here as we need to be
+# able to run this file in standalone mode, as if the proto files are not
+# generated, some imports in `faasmctl` will fail
+GEN_PROTO_DIR = join(FAASMCTL_ROOT, "util", "gen_proto")
+FAASM_CLI_IMAGE = "faasm.azurecr.io/cli"
+
+PROTO_FILES = [
+    "faabric_pb2.py",
+    "planner_pb2.py",
+]
+
+
+# We can not import faasmctl here
+def get_faasm_version():
+    ver_file = join(FAASMCTL_ROOT, "util", "faasm.py")
+    cmd = "cat {} | grep 'FAASM_VERSION =' | cut -d' ' -f3".format(ver_file)
+    version = (
+        run(cmd, shell=True, check=True, capture_output=True)
+        .stdout.decode("utf-8")
+        .strip()[1:-1]
+    )
+
+    return version
+
+
+def gen_proto_files(clean=False):
+    """
+    Generate python proto files to interact with the Faasm cluster
+    """
+    if clean:
+        rmtree(GEN_PROTO_DIR)
+
+    if not exists(GEN_PROTO_DIR):
+        makedirs(GEN_PROTO_DIR)
+
+    pb_files = [f for f in listdir(GEN_PROTO_DIR) if f.endswith("pb2.py")]
+    pb_files.sort()
+
+    if pb_files == PROTO_FILES:
+        return
+
+    if "FAASM_VERSION" in environ:
+        faasm_ver = environ["FAASM_VERSION"]
+    else:
+        faasm_ver = get_faasm_version()
+
+    print("Generating Faasm (v{}) protobuf files...".format(faasm_ver))
+    tmp_ctr_name = "faasm_gen_proto"
+    cm = "docker run -d -i --name {} {}:{}".format(
+        tmp_ctr_name, FAASM_CLI_IMAGE, faasm_ver
+    )
+    run(cm, shell=True, check=True)
+
+    # Find the right protoc binary
+    docker_exec_prefix = "docker exec {}".format(tmp_ctr_name)
+    find_protoc_cmd = "{} bash -c 'find ~/.conan -name protoc'".format(
+        docker_exec_prefix
+    )
+    protoc_bin = (
+        run(find_protoc_cmd, shell=True, capture_output=True)
+        .stdout.decode("utf-8")
+        .split("\n")
+    )
+    p_bin = [p_bin for p_bin in protoc_bin if "build_subfolder" in p_bin]
+    p_bin = p_bin[0].strip()
+
+    # Generate python protobuf files
+    code_dir = "/usr/local/code/faasm/faabric"
+    protoc_cmd = [
+        p_bin,
+        "--proto_path={}".format(code_dir),
+        "--python_out={}".format(code_dir),
+        "{}/src/planner/planner.proto".format(code_dir),
+        "{}/src/proto/faabric.proto".format(code_dir),
+    ]
+    protoc_cmd = " ".join(protoc_cmd)
+    docker_cmd = "{} bash -c '{}'".format(docker_exec_prefix, protoc_cmd)
+    run(docker_cmd, shell=True, check=True)
+
+    # Finally, copy the generated protobuf files to the desired location
+    for proto_file in PROTO_FILES:
+        if "planner" in proto_file:
+            proto_ctr_path = join(code_dir, "src", "planner", proto_file)
+        else:
+            proto_ctr_path = join(code_dir, "src", "proto", proto_file)
+        proto_faasmctl_path = join(GEN_PROTO_DIR, proto_file)
+
+        docker_cp_cmd = "docker cp {}:{} {}".format(
+            tmp_ctr_name, proto_ctr_path, proto_faasmctl_path
+        )
+        run(docker_cp_cmd, shell=True, check=True)
+
+    # Delete container
+    run("docker rm -f {}".format(tmp_ctr_name), shell=True, check=True)
+    print("Done generating protobuf files!")
+
+
+if __name__ == "__main__":
+    clean = len(argv) == 2 and argv[1] == "--clean"
+    gen_proto_files(clean)

myfaasmctl-0.0.1/faasmctl/main.py

@@ -0,0 +1,14 @@
+from invoke import Program
+from faasmctl.tasks import task_ns
+from faasmctl.util.version import get_version
+
+
+def main():
+    program = Program(
+        name="faasmctl",
+        binary="faasmctl",
+        binary_names=["faasmctl"],
+        namespace=task_ns,
+        version=get_version(),
+    )
+    program.run()

myfaasmctl-0.0.1/faasmctl/tasks/__init__.py

@@ -0,0 +1,29 @@
+from invoke import Collection
+
+from . import cli
+from . import delete
+from . import deploy
+from . import flush
+from . import generate
+from . import invoke
+from . import logs
+from . import monitor
+from . import restart
+from . import scale
+from . import status
+from . import upload
+
+task_ns = Collection(
+    cli,
+    delete,
+    deploy,
+    generate,
+    flush,
+    invoke,
+    logs,
+    monitor,
+    restart,
+    scale,
+    status,
+    upload,
+)

myfaasmctl-0.0.1/faasmctl/tasks/cli.py

@@ -0,0 +1,150 @@
+from faasmctl.util.compose import run_compose_cmd, wait_for_venv
+from faasmctl.util.config import (
+    BACKEND_INI_STRING,
+    get_faasm_ini_file,
+    get_faasm_ini_value,
+)
+from faasmctl.util.docker import get_docker_tag
+from invoke import task
+from os.path import abspath, exists
+from subprocess import run
+
+
+def do_run_cmd(cli, cmd, cp_in, cp_out, env, ini_file):
+    if not ini_file:
+        ini_file = get_faasm_ini_file()
+
+    backend = get_faasm_ini_value(ini_file, "Faasm", BACKEND_INI_STRING)
+    if backend == "compose":
+        # To run a command in a `compose` backend, we fist start the CLI
+        # container in dettached mode (if it does not exist yet) and then we
+        # exec into it, copying the ini file
+        up_cmd = "up -d --no-recreate {}".format(cli)
+        run_compose_cmd(ini_file, up_cmd)
+
+        # Second, copy the the ini file inside the container
+        ini_file = abspath(ini_file)
+        ini_file_ctr_path = "/tmp/faasm.ini"
+        cp_cmd = "cp {} {}:{}".format(ini_file, cli, ini_file_ctr_path)
+        run_compose_cmd(ini_file, cp_cmd)
+
+        # Third, wait for the virtual environment to be ready if we need to. We
+        # only need to wait for the virtual environment if we are either
+        # mounting the source, or using one of the clients
+        wait_for_venv(ini_file, cli)
+
+        # Copy files in before execution
+        if cp_in:
+            host_path = abspath(cp_in.split(":")[0])
+            if not exists(host_path):
+                print("Host path to copy from does not exist ({})".format(host_path))
+                raise RuntimeError("Host path to copy from does not exist")
+            ctr_path = cp_in.split(":")[1]
+
+            cp_cmd = "cp {} {}:{}".format(host_path, cli, ctr_path)
+            run_compose_cmd(ini_file, cp_cmd)
+
+        # Lastly, actually run the requested command
+        compose_cmd = [
+            "exec",
+            "-e FAASM_INI_FILE={}".format(ini_file_ctr_path),
+            " ".join(["-e {}".format(var) for var in env.split(",")])
+            if env is not None
+            else "",
+            "-it" if not cmd else "",
+            cli,
+            "bash" if not cmd else cmd,
+        ]
+        compose_cmd = " ".join(compose_cmd)
+        run_compose_cmd(ini_file, compose_cmd)
+
+        # Copy files out after execution
+        if cp_out:
+            ctr_path = cp_out.split(":")[0]
+            host_path = abspath(cp_out.split(":")[1])
+
+            cp_cmd = "cp {}:{} {}".format(cli, ctr_path, host_path)
+            run_compose_cmd(ini_file, cp_cmd)
+
+    elif backend == "k8s":
+        # Using a CLI container with a cluster that runs on a `k8s` backend is
+        # only supported to upload functions from the CPP or Python container.
+        # As such we: (i) disable cli.faasm calls on a `k8s` backend, and (ii)
+        # use a standalone container to execute the command that we remove
+        # immediately after (without mounting any files)
+        ini_file_ctr_path = "/tmp/faasm.ini"
+        work_dir = get_faasm_ini_value(ini_file, "Faasm", "working_dir")
+
+        if cli == "cpp":
+            image_tag = get_docker_tag(work_dir, "CPP_CLI_IMAGE")
+        elif cli == "python":
+            image_tag = get_docker_tag(work_dir, "PYTHON_CLI_IMAGE")
+        else:
+            raise RuntimeError("Can't call cli.faasm on a `k8s` cluster!")
+
+        docker_cmd = [
+            "docker run --rm",
+            "-v {}:{}".format(ini_file, ini_file_ctr_path),
+            "-e FAASM_INI_FILE={}".format(ini_file_ctr_path),
+            "-it" if not cmd else "",
+            image_tag,
+            "bash" if not cmd else cmd,
+        ]
+        docker_cmd = " ".join(docker_cmd)
+
+        run(docker_cmd, shell=True)
+
+    else:
+        raise RuntimeError("Unrecognised backend: {}".format(backend))
+
+
+@task
+def faasm(ctx, cmd=None, cp_in=None, cp_out=None, env=None, ini_file=None):
+    """
+    Run a command in the Faasm CLI container
+
+    By default, if --cmd is set to None, we will get a shell into the
+    container. If the --cmd argument is set, we execute the cmd string
+
+    Parameters:
+    - cmd (str): command to run in the CLI container
+    - cp_in (str): file to copy into the CLI as host_path:ctr_path
+    - cp_out (str): file to copy out of the CLI as ctr_path:host_path
+    - env (str): comma-separated ENV=VAR environment variables for cmd
+    - ini_file (str): path to the cluster's INI file
+    """
+    do_run_cmd("faasm-cli", cmd, cp_in, cp_out, env, ini_file)
+
+
+@task
+def cpp(ctx, cmd=None, cp_in=None, cp_out=None, env=None, ini_file=None):
+    """
+    Run a command in the CPP CLI container
+
+    By default, if --cmd is set to None, we will get a shell into the
+    container. If the --cmd argument is set, we execute the cmd string
+
+    Parameters:
+    - cmd (str): command to run in the CLI container
+    - cp_in (str): file to copy into the CLI as host_path:ctr_path
+    - cp_out (str): file to copy out of the CLI as ctr_path:host_path
+    - ini_file (str): path to the cluster's INI file
+    """
+    do_run_cmd("cpp", cmd, cp_in, cp_out, env, ini_file)
+
+
+@task
+def python(ctx, cmd=None, cp_in=None, cp_out=None, env=None, ini_file=None):
+    """
+    Run a command in the Python CLI container
+
+    By default, if --cmd is set to None, we will get a shell into the
+    container. If the --cmd argument is set, we execute the cmd string
+
+    Parameters:
+    - cmd (str): command to run in the CLI container
+    - cp_in (str): file to copy into the CLI as host_path:ctr_path
+    - cp_out (str): file to copy out of the CLI as ctr_path:host_path
+    - ini_file (str): path to the cluster's INI file
+    """
+    do_run_cmd("python", cmd, cp_in, cp_out, env, ini_file)

myfaasmctl-0.0.1/faasmctl/tasks/delete.py

@@ -0,0 +1,28 @@
+from faasmctl.util.compose import delete_compose_cluster
+from faasmctl.util.config import get_faasm_ini_file, get_faasm_ini_value
+from faasmctl.util.k8s import delete_k8s_cluster
+from invoke import task
+from os import remove
+
+
+@task(default=True)
+def delete(ctx, ini_file=None):
+    """
+    Delete a running Faasm cluster
+
+    Parameters:
+    - ini_file (str): path to the cluster's INI file (FAASM_INI_FILE env. var
+                      if not found)
+    """
+    if not ini_file:
+        ini_file = get_faasm_ini_file()
+
+    backend = get_faasm_ini_value(ini_file, "Faasm", "backend")
+    if backend == "compose":
+        delete_compose_cluster(ini_file)
+    elif backend == "k8s":
+        delete_k8s_cluster(ini_file)
+    else:
+        raise RuntimeError("Unsupported backend: {}".format(backend))
+
+    remove(ini_file)