Initial commit

Change-Id: I2a8b20cf1aa463a90fdb03d8c59a338b0d28ba23
Signed-off-by: Baha Mesleh <baha.mesleh@nokia.com>

diff --git a/.gitreview b/.gitreview
new file mode 100644 (file)
index 0000000..a5c98c5
--- /dev/null
+++ b/.gitreview
@@ -0,0 +1,5 @@
+[gerrit]
+host=gerrit.akraino.org
+port=29418
+project=ta/lockcli
+defaultremote=origin

diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..d645695
--- /dev/null
+++ b/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 "[]"
+      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 [yyyy] [name of copyright owner]
+
+   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.

diff --git a/lockcli.spec b/lockcli.spec
new file mode 100644 (file)
index 0000000..b89ce5f
--- /dev/null
+++ b/lockcli.spec
@@ -0,0 +1,54 @@
+# Copyright 2019 Nokia
+
+# 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.
+
+Name:       lockcli
+Version:    %{_version}
+Release:    1%{?dist}
+Summary:    Contains code for the lock CLI
+License:    %{_platform_licence}
+Source0:    %{name}-%{version}.tar.gz
+Vendor:     %{_platform_vendor}
+BuildArch:  noarch
+
+BuildRequires: python
+BuildRequires: python-setuptools
+Requires: python-etcd
+Requires: etcd
+
+%description
+This RPM contains source code for the lock cli
+
+%prep
+%autosetup
+
+%install
+mkdir -p %{buildroot}/%{_python_site_packages_path}/lockcli/
+set -e
+cd src && python setup.py install --root %{buildroot} --no-compile --install-purelib %{_python_site_packages_path} --install-scripts %{_platform_bin_path} && cd -
+
+%files
+%defattr(0755,root,root,0755)
+%{_python_site_packages_path}/lockcli*
+%{_platform_bin_path}/lockcli
+
+%pre
+
+%post
+
+%preun
+
+%postun
+
+%clean
+rm -rf %{buildroot}

diff --git a/src/lockcli/__init__.py b/src/lockcli/__init__.py
new file mode 100644 (file)
index 0000000..287b513
--- /dev/null
+++ b/src/lockcli/__init__.py
@@ -0,0 +1,15 @@
+# Copyright 2019 Nokia
+
+# 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__('pkg_resources').declare_namespace(__name__)

diff --git a/src/lockcli/handlers.py b/src/lockcli/handlers.py
new file mode 100644 (file)
index 0000000..efc911c
--- /dev/null
+++ b/src/lockcli/handlers.py
@@ -0,0 +1,127 @@
+# Copyright 2019 Nokia
+
+# 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 __future__ import print_function
+import sys
+import inspect
+import etcd
+
+
+class VerboseLogger(object):
+    def __call__(self, msg):
+        print(msg)
+
+
+class CLIHandler(object):
+    def __init__(self):
+        self.sock = None
+        self.verbose_logger = VerboseLogger()
+        self.client = None
+
+    def _init_api(self, server, port, verbose):
+        logger = None
+        if verbose:
+            logger = self.verbose_logger
+
+        if server == 'none':
+            import socket
+            server = socket.gethostname()
+
+        self.client = etcd.Client(server, port)
+
+    def set_handler(self, subparser):
+        subparser.set_defaults(handler=self)
+
+    def init_subparser(self, subparsers):
+        raise Error('Not implemented')
+
+    def __call__(self, args):
+        raise Error('Not implemented')
+
+
+class CLILockHandler(CLIHandler):
+    def init_subparser(self, subparsers):
+        subparser = subparsers.add_parser('lock', help='Acquire a lock')
+        subparser.add_argument('--id',
+                               required=True,
+                               dest='id',
+                               metavar='ID',
+                               type=str,
+                               action='store')
+
+        subparser.add_argument('--timeout',
+                               required=True,
+                               dest='timeout',
+                               metavar='TIMEOUT',
+                               type=int,
+                               action='store')
+
+        self.set_handler(subparser)
+
+    def __call__(self, args):
+        self._init_api(args.server, args.port, args.verbose)
+        lock = etcd.Lock(self.client, args.id)
+        result = lock.acquire(blocking=False, lock_ttl=args.timeout)
+        if not result:
+            raise Exception('Lock taken!')
+
+        print('Lock acquired successfully!')
+        print('uuid=%s' % lock.uuid)
+
+class CLIUnlockHandler(CLIHandler):
+    def init_subparser(self, subparsers):
+        subparser = subparsers.add_parser('unlock', help='Release a lock')
+        subparser.add_argument('--id',
+                               required=True,
+                               dest='id',
+                               metavar='ID',
+                               type=str,
+                               action='store')
+
+        subparser.add_argument('--uuid',
+                               required=True,
+                               dest='uuid',
+                               metavar='UUID',
+                               type=str,
+                               action='store')
+        self.set_handler(subparser)
+
+    def __call__(self, args):
+        self._init_api(args.server, args.port, args.verbose)
+        lock = etcd.Lock(self.client, args.id)
+        try:
+            lock._uuid = args.uuid
+            lock.release()
+            print('Lock released successfully!')
+        except ValueError:
+            print('Lock is not held!')
+
+def get_handlers_list():
+    handlers = []
+    for name, obj in inspect.getmembers(sys.modules[__name__]):
+        if inspect.isclass(obj):
+            if name is not 'CLIHandler':
+                if issubclass(obj, CLIHandler):
+                    handlers.append(obj())
+    return handlers
+
+
+def main():
+    handlers = get_handlers_list()
+    for handler in handlers:
+        print('handler is ', handler)
+
+
+if __name__ == '__main__':
+    main()

diff --git a/src/lockcli/main.py b/src/lockcli/main.py
new file mode 100755 (executable)
index 0000000..f25be71
--- /dev/null
+++ b/src/lockcli/main.py
@@ -0,0 +1,34 @@
+#! /usr/bin/python
+
+# Copyright 2019 Nokia
+
+# 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 __future__ import print_function
+import sys
+from lockcli import processors
+
+
+def main():
+    try:
+        processor = processors.CLIProcessor('lockcli')
+        args = sys.argv[1:]
+        processor(args)
+    except Exception as exp:  # pylint: disable=broad-except
+        print('Failed with error: %s' % str(exp))
+        return 1
+    return 0
+
+
+if __name__ == '__main__':
+    sys.exit(main())

diff --git a/src/lockcli/processors.py b/src/lockcli/processors.py
new file mode 100644 (file)
index 0000000..3d1c674
--- /dev/null
+++ b/src/lockcli/processors.py
@@ -0,0 +1,69 @@
+# Copyright 2019 Nokia
+
+# 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 __future__ import print_function
+import sys
+import argparse
+from lockcli import handlers as clihandlers
+
+
+class CLIProcessor(object):
+    def __init__(self, prog):
+        self.prog = prog
+
+    def __call__(self, args):
+        parser = argparse.ArgumentParser(description='Lock CLI', prog=self.prog)
+        parser.add_argument('--server',
+                            dest='server',
+                            metavar='SERVER',
+                            required=False,
+                            default='none',
+                            type=str,
+                            action='store')
+
+        parser.add_argument('--port',
+                            dest='port',
+                            metavar='PORT',
+                            required=False,
+                            default=2379,
+                            type=int,
+                            action='store')
+
+        parser.add_argument('--verbose',
+                            required=False,
+                            default=False,
+                            action='store_true')
+
+        subparsers = parser.add_subparsers()
+        handlers = clihandlers.get_handlers_list()
+        for handler in handlers:
+            handler.init_subparser(subparsers)
+
+        parse_result = parser.parse_args(args)
+
+        parse_result.handler(parse_result)
+
+
+def main():
+    processor = CLIProcessor('lockcli')
+    args = sys.argv[1:]
+    try:
+        processor(args)
+    except Exception as error:  # pylint: disable=broad-except
+        print('Got error %s' % str(error))
+        sys.exit(1)
+
+
+if __name__ == '__main__':
+    main()

diff --git a/src/setup.py b/src/setup.py
new file mode 100644 (file)
index 0000000..bdc0eee
--- /dev/null
+++ b/src/setup.py
@@ -0,0 +1,33 @@
+# Copyright 2019 Nokia
+
+# 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 setuptools import setup, find_packages
+setup(
+    name='lockcli',
+    version='1.0',
+    license='Apache v2.0',
+    long_description='README.txt',
+    author='Baha Mesleh',
+    author_email='baha.mesleh@nokia.com',
+    namespace_packages=['lockcli'],
+    packages=find_packages(),
+    include_package_data=True,
+    description='Lock CLI',
+    entry_points={
+        'console_scripts': [
+            'lockcli = lockcli.main:main'
+        ],
+    },
+    zip_safe=False,
+)