From 627f561a764605d48276ebd697aec2d0b57c17f6 Mon Sep 17 00:00:00 2001 From: Guillermo Adrian Ponce Date: Wed, 27 Jul 2016 10:56:56 -0500 Subject: [PATCH] Initial commit Signed-off-by: Guillermo Adrian Ponce --- LICENSE | 177 ++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 66 +++++++++++++++++ setup.py | 29 ++++++++ swupd/__init__.py | 107 ++++++++++++++++++++++++++++ 4 files changed, 379 insertions(+) create mode 100644 LICENSE create mode 100644 README.rst create mode 100644 setup.py create mode 100755 swupd/__init__.py diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f433b1a --- /dev/null +++ b/LICENSE @@ -0,0 +1,177 @@ + + 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 diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..1560e17 --- /dev/null +++ b/README.rst @@ -0,0 +1,66 @@ +Python swupd bindings +===================== + +Module Description +`````````````````` + +swupd.py is an API module intended for developers that want to add swupd +functionality (install, remove, update) into their codes. + +Prerequisites +------------- +- swupd: https://clearlinux.org/features/software-update + + +Functions +---------- +get_latest_version + :Description: Gets the latest Clear Linux version as stated at: + https://download.clearlinux.org/update/version/formatstaging/latest + :Arguments: None + :Returns: latest Clear Linux Version as string +get_bundle_list + :Description: Gets the names of all the available bundles for a given Clear Linux version + :Arguments: Clear Linux version number as string + :Returns: List of bundles as list +get_installed_bundles + :Description: Gets the names of the bundles installed in the system + :Arguments: None + :Returns: List of bundles as list +install_bundles + :Description: Install one or more bundles in the system + :Arguments: List of bundles as list + F: Format, optional as string + url: URL, optional as string + :Returns: stdout as string, stderr as string, exit status as int +remove_bundles + :Description: Removes one or more bundles from the system + :Arguments: List of bundles as list + :Returns: stdout as string, stderr as string, exit status as int +update + :Description: Performs a full update of the system + :Arguments: None + :Returns: stdout as string, stderr as string, exit status as int + +Examples +```````` + +>>> Python 2.7.11 (default, May 1 2016, 00:18:30) +[GCC 6.1.0] on linux2 +Type "help", "copyright", "credits" or "license" for more information. +>>> import swupd + +>>> swupd.get_latest_version() +'9400' + +>>> swupd.get_bundle_list('9400') +['sysadmin', 'os-cloudguest-cci', 'openstack-all-in-one', 'devtools-extras', 'kernel-embedded', ... , 'opencontainers-dev', 'machine-learning-basic', 'go-basic', 'dev-utils', 'bootloader'] + +>>> swupd.get_installed_bundles() +['R-extras', 'pxe-server', 'network-proxy-client', 'R-basic', 'koji', ... , 'mail-utils', 'openstack-python-clients', 'sysadmin-hostmgmt', 'os-utils-gui', 'go-extras'] + +>>> swupd.install_bundles(['games','rust-basic']) +('swupd-client bundle adder 3.5.5\n Copyright (C) 2012-2016 Intel Corporation\n\nDownloading required packs...\nAttempting to download version string to memory\nInstalling bundle(s) files...\nCalling post-update helper scripts.\nNo kernel update needed, skipping helper call out.\nNo bootloader update needed, skipping helper call out.\nBundle(s) installation done.\nswupd-client bundle adder 3.5.5\n Copyright (C) 2012-2016 Intel Corporation\n\nDownloading required packs...\nAttempting to download version string to memory\nInstalling bundle(s) files...\nCalling post-update helper scripts.\nNo kernel update needed, skipping helper call out.\nNo bootloader update needed, skipping helper call out.\nBundle(s) installation done.\n', '', 0) + +>>> swupd.remove_bundles(['games','rust-basic']) +('swupd-client bundle remover 3.5.5\n Copyright (C) 2012-2016 Intel Corporation\n\nDeleting bundle files...\nTotal deleted files: 23\nUntracking bundle from system...\nSuccess: Bundle removed\nswupd-client bundle remover 3.5.5\n Copyright (C) 2012-2016 Intel Corporation\n\nDeleting bundle files...\nTotal deleted files: 43\nUntracking bundle from system...\nSuccess: Bundle removed\n', '', 0) diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..7b6b8a4 --- /dev/null +++ b/setup.py @@ -0,0 +1,29 @@ +#!/usr/bin/env python +from setuptools import setup + +def readme(): + with open("README.rst") as f: + return f.read() + +setup ( + name='swupd', + version='0.1.0', + description='Python bindings for swupd', + long_description=readme(), + author='Guillermo Ponce', + author_email='guillermo.a.ponce.castneda@intel.com', + license='Apache-2.0', + packages=['swupd'], + platforms='Clear Linux for Intel Architecture', + classifiers=[ + 'Environment :: Console', + 'Intended Audience :: System Administrators', + 'License :: OSI Approved :: Apache Software License', + 'Operating System :: POSIX :: Linux', + 'Programming Language :: Python :: 2', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.6', + 'Topic :: System :: Installation/Setup', + ], +) diff --git a/swupd/__init__.py b/swupd/__init__.py new file mode 100755 index 0000000..5c75ce0 --- /dev/null +++ b/swupd/__init__.py @@ -0,0 +1,107 @@ +#/usr/bin/env python +import subprocess +import urllib2 +import os + + +def get_latest_version(): + url = 'https://download.clearlinux.org/update/version/formatstaging/latest' + f = urllib2.urlopen(url) + content = f.read().rstrip('\n') + return content + + +def get_bundle_list(version): + base_url = 'https://download.clearlinux.org/update/' + MoM_url = base_url + str(version) + '/Manifest.MoM' + bundle_list = [] + f = urllib2.urlopen(MoM_url) + content = f.read().rstrip('\n') + file_out = content.split('\n') + for fo in file_out: + l = fo.split('\t') + if len(l) == 4: + bundle_list.append(l[-1]) + return bundle_list + + +def get_installed_bundles(): + bundles_dir = '/usr/share/clear/bundles/' + p = os.listdir(bundles_dir) + return p + + +def install_bundles(bundle_list, F=None, url=None): + latest_version = get_latest_version() + installed_bundles = get_installed_bundles() + bundle_universe = get_bundle_list(latest_version) + exit_status = 0 + out = "" + err_ = "" + err = "" + if len(bundle_list) == 0: + err = "Bundle list was empty" + for bundle in bundle_list: + if(bundle in installed_bundles): + err_ += "The bundle " + str(bundle) + err_ += " is already installed" + err = "" + exit_status = 1 + else: + cmd = ['sudo','swupd','bundle-add'] + if bundle in bundle_universe: + cmd += [bundle] + if F is not None: + cmd += ['-F', F] + if url is not None: + cmd += ['-u', url] + cmd += [bundle] + p = subprocess.Popen(cmd, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + o, e = p.communicate() + out += o + err += e + if exit_status == 0: + exit_status = p.returncode + else: + err_ += "The bundle " + str(bundle) + err_ += " does not exists on Clear Linux bundle universe" + exit_status = 1 + err = str(err_) + str(err) + return (out, err, exit_status) + + +def remove_bundles(bundle_list): + installed_bundles = get_installed_bundles() + exit_status = 0 + out = "" + err = "" + err_ = "" + for bundle in bundle_list: + if(bundle in installed_bundles): + p = subprocess.Popen(['sudo', 'swupd', 'bundle-remove', bundle], + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + o, e = p.communicate() + out += o + err += e + if exit_status == 0: + exit_status = p.returncode + else: + err_ += "The bundle " + str(bundle) + " is not installed" + exit_status = 1 + err = str(err_) + str(err) + return (out, err, exit_status) + + +def update(): + exit_status = 0 + out = "" + err = "" + p = subprocess.Popen(['sudo', 'swupd', 'update'], + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + out, err = p.communicate() + exit_status = p.returncode + return (out, err, exit_status)