avmesos-cli 1.0.0__tar.gz

avmesos-cli-1.0.0/.gitignore

@@ -0,0 +1,8 @@
+*.pyc
+.virtualenv
+.coverage
+.tox
+build/
+dist/
+avmesos_cli.egg-info/
+avmesos.egg-info

avmesos-cli-1.0.0/Makefile

@@ -0,0 +1,37 @@
+#Dockerfile vars
+
+#vars
+
+.PHONY: help build bootstrap all
+
+help:
+	    @echo "Makefile arguments:"
+	    @echo ""
+	    @echo "Makefile commands:"
+	    @echo "build"
+	    @echo "all"
+			@echo "publish"
+			@echo ${TAG}
+
+.DEFAULT_GOAL := all
+
+build:	
+	@echo ">>>> Build python module"
+	@python3 setup.py sdist bdist_wheel	
+
+upload:
+	@python3 -m twine upload --repository pypi dist/*
+
+install:	
+	@echo ">>>> Install python module"
+	@pip3 install .
+
+install-dev:	
+	@echo ">>>> Install python module development"
+	@pip3 install -e .
+
+docs:
+	@echo ">>>> Build docs"
+	$(MAKE) -C $@
+
+all: build

avmesos-cli-1.0.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.1
+Name: avmesos-cli
+Version: 1.0.0
+Summary: Apache Mesos CLI
+Home-page: https://www.aventer.biz/
+Author: AVENTER UG (haftungsbeschraenkt)
+Author-email: support@aventer.biz
+License: Apache License 2.0
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+
+# Mesos CLI
+
+## Prerequisites
+
+Make sure you have python 3.6 or newer installed
+on your system before you begin.
+
+## How to install 
+
+```bash
+
+pip install avmesos-cli
+
+```
+
+## Setting up your configuration
+
+In order to use this tool, you will need to create a
+configuration file in your home directory under
+`~/.mesos/config.toml`. A template for this config can be
+seen below:
+
+```
+# The `plugins` is an array listing the absolute paths of the
+# plugins you want to add to the CLI.
+plugins = [
+  "</absolute/path/to/plugin-1/directory>",
+  "</absolute/path/to/plugin-2/directory>"
+]
+
+# The `master` is a field that has to be composed of an
+# `address` or `zookeeper` field, but not both. For example:
+[master]
+  address = "10.10.0.30:5050"
+  principal = "username"
+  secret = "password"
+
+[agent]
+  ssl = true
+  ssl_verify = false
+  principal = "username"
+  secret = "password"
+  timeout = 5
+```
+
+You can override the location of this configuration file using
+the environment variable `MESOS_CLI_CONFIG`.
+
+## How to use it
+
+```bash
+$ mesos-cli 
+
+Mesos CLI
+
+Usage:
+  mesos (-h | --help)
+  mesos --version
+  mesos <command> [<args>...]
+
+Options:
+  -h --help  Show this screen.
+  --version  Show version info.
+
+Commands:
+  agent      Interacts with the Mesos agents
+  config     Interacts with the Mesos CLI configuration file
+  framework  Interacts with the Mesos Frameworks
+  task       Interacts with the tasks running in a Mesos cluster
+
+See 'mesos help <command>' for more information on a specific command.
+
+```

avmesos-cli-1.0.0/README.md

@@ -0,0 +1,73 @@
+# Mesos CLI
+
+## Prerequisites
+
+Make sure you have python 3.6 or newer installed
+on your system before you begin.
+
+## How to install 
+
+```bash
+
+pip install avmesos-cli
+
+```
+
+## Setting up your configuration
+
+In order to use this tool, you will need to create a
+configuration file in your home directory under
+`~/.mesos/config.toml`. A template for this config can be
+seen below:
+
+```
+# The `plugins` is an array listing the absolute paths of the
+# plugins you want to add to the CLI.
+plugins = [
+  "</absolute/path/to/plugin-1/directory>",
+  "</absolute/path/to/plugin-2/directory>"
+]
+
+# The `master` is a field that has to be composed of an
+# `address` or `zookeeper` field, but not both. For example:
+[master]
+  address = "10.10.0.30:5050"
+  principal = "username"
+  secret = "password"
+
+[agent]
+  ssl = true
+  ssl_verify = false
+  principal = "username"
+  secret = "password"
+  timeout = 5
+```
+
+You can override the location of this configuration file using
+the environment variable `MESOS_CLI_CONFIG`.
+
+## How to use it
+
+```bash
+$ mesos-cli 
+
+Mesos CLI
+
+Usage:
+  mesos (-h | --help)
+  mesos --version
+  mesos <command> [<args>...]
+
+Options:
+  -h --help  Show this screen.
+  --version  Show version info.
+
+Commands:
+  agent      Interacts with the Mesos agents
+  config     Interacts with the Mesos CLI configuration file
+  framework  Interacts with the Mesos Frameworks
+  task       Interacts with the tasks running in a Mesos cluster
+
+See 'mesos help <command>' for more information on a specific command.
+
+```

avmesos-cli-1.0.0/avmesos/__init__.py

@@ -0,0 +1,26 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+"""
+Client library for the Mesos HTTP ReST API
+"""
+
+__version__ = '0.0.0.dev'
+
+__all__ = ['exceptions', 'http', 'recordio']
+from . import exceptions
+from . import http
+from . import recordio

avmesos-cli-1.0.0/avmesos/cli/__init__.py

@@ -0,0 +1,26 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+"""
+Mesos CLI Module
+"""
+
+# pylint: disable=cyclic-import
+from . import config
+from . import plugins
+
+from . import exceptions
+from . import util

avmesos-cli-1.0.0/avmesos/cli/config.py

@@ -0,0 +1,239 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+"""
+Config class to manage the configuration file.
+"""
+
+import os
+import toml
+
+import requests
+
+from avmesos import cli
+from avmesos.cli.constants import DEFAULT_MASTER_IP
+from avmesos.cli.constants import DEFAULT_MASTER_PORT
+from avmesos.cli.exceptions import CLIException
+
+
+class Config():
+    """
+    The Config class loads the configuration file on initialization and has
+    one method for each element that can be specified in the config file.
+    """
+
+    def __init__(self, settings):
+        # Load the configuration file path for the CLI.
+        if os.environ.get("MESOS_CLI_CONFIG"):
+            self.path = os.environ["MESOS_CLI_CONFIG"]
+        else:
+            self.path = settings.DEFAULT_MESOS_CLI_CONFIG
+
+        # Load the configuration file as a TOML file.
+        try:
+            self.data = toml.load(self.path)
+        except Exception as exception:
+            raise CLIException("Error loading config file as TOML: {error}"
+                               .format(error=exception))
+
+    def master(self):
+        """
+        Parse the master info in the configuration file and return
+        its IP address and the port where Mesos is running.
+        """
+        master = "{ip}:{port}".format(ip=DEFAULT_MASTER_IP,
+                                      port=DEFAULT_MASTER_PORT)
+
+        if "master" in self.data:
+            if not isinstance(self.data["master"], dict):
+                raise CLIException("The 'master' field must be a dictionary")
+
+            if ("address" not in self.data["master"] and
+                    "zookeeper" not in self.data["master"]):
+                raise CLIException("The 'master' field must either"
+                                   " contain an 'address' field or"
+                                   " a 'zookeeper' dictionary")
+            if ("address" in self.data["master"] and
+                    "zookeeper" in self.data["master"]):
+                raise CLIException("The 'master' field should only contain "
+                                   " an 'address' field or a 'zookeeper'"
+                                   " dictionary but not both")
+
+            if "address" in self.data["master"]:
+                master_address = self.data["master"]["address"]
+                try:
+                    master = cli.util.sanitize_address(master_address)
+                except Exception as exception:
+                    raise CLIException("The 'master' address {address} is"
+                                       " formatted incorrectly: {error}"
+                                       .format(address=master_address,
+                                               error=exception))
+
+            if "zookeeper" in self.data["master"]:
+                zk_field = self.data["master"]["zookeeper"]
+
+                if ("addresses" not in zk_field or
+                        not isinstance(zk_field["addresses"], list)):
+                    raise CLIException("The 'zookeeper' field must contain"
+                                       " an 'addresses' list")
+
+                if ("path" not in zk_field or
+                        not isinstance(zk_field["path"], str)):
+                    raise CLIException("The 'zookeeper' field must contain"
+                                       " a 'path' field")
+
+                if not zk_field["path"].startswith("/"):
+                    raise CLIException("The 'zookeeper' field 'path'"
+                                       " must start with a '/'")
+                if len(zk_field["path"]) == 1:
+                    raise CLIException("The 'zookeeper' field 'path' should"
+                                       " be nested ('/' is not supported)")
+
+                for address in zk_field["addresses"]:
+                    try:
+                        cli.util.sanitize_address(address)
+                    except Exception as exception:
+                        raise CLIException("The 'zookeeper' address {address}"
+                                           " is formatted incorrectly: {error}"
+                                           .format(address=address,
+                                                   error=exception))
+                try:
+                    master = cli.util.zookeeper_resolve_leader(
+                        zk_field["addresses"], zk_field["path"])
+                except Exception as exception:
+                    raise CLIException("Could not resolve the"
+                                       " leading master: {error}"
+                                       .format(error=exception))
+
+        return master
+
+    def principal(self):
+        """
+        Return the principal in the configuration file
+        """
+        return self.data["master"].get("principal")
+
+    def secret(self):
+        """
+        Return the secret in the configuration file
+        """
+        return self.data["master"].get("secret")
+
+    def agent_ssl(self, default=False):
+        """
+        Return if the agent support ssl
+        """
+        if "agent" in self.data:
+            agent_ssl = self.data["agent"].get("ssl", default)
+            if not isinstance(agent_ssl, bool):
+                raise CLIException("The 'agent->ssl' field"
+                                   " must be True/False")
+
+            return agent_ssl
+
+        return default
+
+    def agent_ssl_verify(self, default=False):
+        """
+        Return if the ssl certificate should be verified
+        """
+        if "agent" in self.data:
+            ssl_verify = self.data["agent"].get("ssl_verify", default)
+            if not isinstance(ssl_verify, bool):
+                raise CLIException("The 'agent->ssl_verify' field"
+                                   " must be True/False")
+
+            return ssl_verify
+
+        return default
+    
+    def ssl_verify(self, default=False):
+        """
+        Return if the ssl certificate should be verified
+        """
+        if "master" in self.data:
+            ssl_verify = self.data["master"].get("ssl_verify", default)
+            if not isinstance(ssl_verify, bool):
+                raise CLIException("The 'master->ssl_verify' field"
+                                   " must be True/False")
+
+            return ssl_verify
+
+        return default
+
+    def agent_timeout(self, default=5):
+        """
+        Return the connection timeout of the agent
+        """
+        if "agent" in self.data:
+            timeout = self.data["agent"].get("timeout", default)
+            if not isinstance(timeout, int):
+                raise CLIException("The 'agent->timeout' field"
+                                   " must be a number in seconds")
+
+            return timeout
+
+        return default
+
+
+    def agent_principal(self):
+        """
+        Return the principal in the configuration file
+        """
+        if "agent" in self.data:
+            return self.data["agent"].get("principal")
+
+        return None
+
+    def agent_secret(self):
+        """
+        Return the secret in the configuration file
+        """
+        if "agent" in self.data:
+            return self.data["agent"].get("secret")
+
+        return None
+
+    def plugins(self):
+        """
+        Parse the plugins listed in the configuration file and return them.
+        """
+        # Allow extra plugins to be pulled in from the configuration file.
+        if "plugins" in self.data:
+            if not isinstance(self.data["plugins"], list):
+                raise CLIException("Unable to parse config file '{path}':"
+                                   " 'plugins' field must be a list"
+                                   .format(path=self.path))
+
+            for plugin in self.data["plugins"]:
+                if not os.path.exists(plugin):
+                    raise CLIException("Plugin path not found: {path}"
+                                       .format(path=plugin))
+            return self.data["plugins"]
+
+        return []
+
+    def authentication_header(self):
+        """
+        Return the BasicAuth authentication header
+        """
+        if (self.agent_principal() is not None
+                and self.agent_secret() is not None):
+            return requests.auth.HTTPBasicAuth(
+                self.agent_principal(),
+                self.agent_secret()
+            )
+        return None

avmesos-cli-1.0.0/avmesos/cli/constants.py

@@ -0,0 +1,25 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+"""
+A collection of constants useful for the CLI.
+"""
+
+DEFAULT_MASTER_IP = "127.0.0.1"
+DEFAULT_MASTER_PORT = "5050"
+
+DEFAULT_AGENT_IP = "127.0.0.1"
+DEFAULT_AGENT_PORT = "5051"

avmesos-cli-1.0.0/avmesos/cli/docopt.py

@@ -0,0 +1,89 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+"""
+Unfortunately, docopt doesn't support multi-word commands.  This is
+important for supporting things like:
+
+mesos cluster ps <args>...
+
+However, it looks like some plans are in place for supporting it in the
+future: https://github.com/docopt/docopt/issues/41
+
+The proposal is to add a "program" keyword argument to docopt to specify the
+full set of words used to represent the command. Since this is not yet
+supported officially, we include the hack below to make it work for us. We
+essentially intercept the call to docopt and make it work with such a "program"
+argument.
+
+To make it work, we inspect the value of "program" and search and replace all
+instances of it in the usage string with a transformed version of it to make it
+a single word (i.e. we replace all spaces with dashes: echo $program | s/
+/-/g). This essentially turns all multi-word commands in the usage string into
+dash-separated single words (e.g., s/mesos cluster ps/mesos-cluster-ps/g). With
+this in place, we then pass this usage string to the original docopt for
+parsing.
+
+Unfortunately, doing things this way means that docopt (by default) will print
+the usage string containing the dashes. To avoid this, we intercept all paths
+where docopt does the printing itself, and transform the usage string back to
+its original form.
+
+Hopefully we can remove this brutal hack at some point in the future
+once docopt supports the "program" argument natively.
+"""
+
+import os
+import sys
+
+# pylint: disable=import-error
+from docopt import docopt as real_docopt, DocoptExit
+
+
+def docopt(usage, **keywords):
+    """ A wrapper around the real docopt parser. """
+    new_usage = usage
+
+    if "program" in keywords:
+        program = keywords.pop("program")
+        new_usage = usage.replace(program, program.replace(" ", "-"))
+
+    try:
+        stdout = sys.stdout
+
+        with open(os.devnull, 'w') as nullfile:
+            sys.stdout = nullfile
+            arguments = real_docopt(new_usage, **keywords)
+            sys.stdout = stdout
+
+        return arguments
+
+    except DocoptExit:
+        sys.stdout = stdout
+        print(usage.strip(), file=sys.stderr)
+        sys.exit(1)
+
+    except SystemExit:
+        sys.stdout = stdout
+
+        if "argv" in keywords and any(h in ("-h", "--help")
+                                      for h in keywords["argv"]):
+            print(usage.strip())
+        elif "version" in keywords and any(v in ("--version")
+                                           for v in keywords["argv"]):
+            print(keywords["version"].strip())
+
+        sys.exit()

avmesos-cli-1.0.0/avmesos/cli/exceptions.py

@@ -0,0 +1,24 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+"""
+CLIException Class
+"""
+
+class CLIException(Exception):
+    """
+    Exceptions class to handle all CLI errors.
+    """