csp-billing-adapter-amazon 1.4.0__tar.gz

csp_billing_adapter_amazon-1.4.0/CHANGES.md

@@ -0,0 +1,76 @@
+v1.4.0 (2026-07-08)
+-------------------
+
+- Add pypi publishing workflow
+- Fix license classifier in setup.py
+- Fix pypi package name in spec file
+- Fix csp billing adapter requirement
+
+v1.3.0 (2025-11-19)
+-------------------
+
+- Add handling for REGION environment variable. If it is
+  set this is preferred to checking the metadata.
+- Add handling for SKIP_METADATA environment variable.
+  If it is set the metadata request will be skipped in
+  account info function.
+
+v1.2.1 (2025-06-10)
+-------------------
+
+- Make customer id required in meter billing hookspec
+
+v1.2.0 (2025-02-21)
+-------------------
+
+- Add batch metering function to handle subscription billing
+
+v1.1.0 (2024-11-25)
+-------------------
+
+- Add plugin file with plugin name for verification
+
+v1.0.0 (2024-06-03)
+-------------------
+
+- Switch spec build to python 3.11
+
+v0.5.1 (2023-10-02)
+-------------------
+
+- Fix metadata url typo
+
+v0.5.0 (2023-09-20)
+-------------------
+
+- Implement get version hookspec
+
+v0.4.0 (2023-08-24)
+-------------------
+
+- Add IPv6 support and IMDSv2
+
+v0.3.0 (2023-08-01)
+-------------------
+
+- Handle billing multiple dimensions.
+
+v0.2.1 (2023-06-16)
+-------------------
+
+- Add region to boto3 client session.
+
+v0.2.0 (2023-05-24)
+-------------------
+
+- Use existing `get_csp_name` function to prevent duplication.
+
+v0.1.0 (2023-05-19)
+-------------------
+
+- Add logging and tests to cover fail cases
+
+v0.0.1 (2023-05-03)
+-------------------
+
+- initial release

csp_billing_adapter_amazon-1.4.0/CONTRIBUTING.md

@@ -0,0 +1,88 @@
+Installation
+============
+
+```shell
+$ git clone https://github.com/SUSE-Enceladus/csp-billing-adapter-amazon.git
+$ cd csp-billing-adapter-amazon
+
+# Activate virtual Environment then install
+# csp-billing-adapter-amazon and dev dependences in editable mode
+$ pip install -e .[dev]
+```
+
+csp-billing-adapter-amazon is now installed in the active virtual environment in development
+mode.
+
+Dev Requirements
+================
+
+- bumpversion
+
+Testing Requirements
+====================
+
+- coverage
+- flake8
+- pytest-cov
+
+Contribution Checklist
+======================
+
+- All patches must be signed. [Signing Commits](#signing-commits)
+- All contributed code must conform to flake8. [Code Style](#code-style)
+- All new code contributions must be accompanied by a test.
+    - Tests must pass and coverage remain above 90%. [Unit & Integration Tests](#unit-&-integration-tests)
+- Follow Semantic Versioning. [Versions & Releases](#versions-&-releases)
+
+Versions & Releases
+===================
+
+**csp-billing-adapter-amazon** adheres to Semantic versioning; see <http://semver.org/> for
+details.
+
+[bumpversion](https://pypi.python.org/pypi/bumpversion/) is used for
+release version management, and is configured in `setup.cfg`:
+
+```shell
+$ bumpversion major|minor|patch
+$ git push
+```
+
+Bumpversion will create a commit with version updated in all locations.
+The annotated tag is created separately.
+
+```shell
+$ git tag -a v{version}
+# git tag -a v0.0.1
+
+# Create a message with the changes since last release and push tags.
+$ git push --tags
+```
+
+Unit & Integration Tests
+========================
+
+All tests should pass and test coverage should remain above 90%.
+
+The tests and coverage can be run directly via pytest.
+
+```shell
+$ pytest --cov=csp_billing_adapter_amazon
+```
+
+Code Style
+==========
+
+Source should pass flake8 and pep8 standards.
+
+```shell
+$ flake8 csp_billing_adapter_amazon
+```
+
+Signing Commits
+===============
+
+The repository and the code base patches sent for inclusion must be GPG
+signed. See the GitHub article, [Signing commits using
+GPG](https://help.github.com/articles/signing-commits-using-gpg/), for
+more information.

csp_billing_adapter_amazon-1.4.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

csp_billing_adapter_amazon-1.4.0/MANIFEST.in

@@ -0,0 +1,13 @@
+include LICENSE
+include CHANGES.md
+include CONTRIBUTING.md
+include README.md
+include csp-billing-adapter-amazon.spec
+include requirements.txt
+include requirements-test.txt
+include requirements-dev.txt
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.coverage
+recursive-exclude * *.py[co]

csp_billing_adapter_amazon-1.4.0/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: csp-billing-adapter-amazon
+Version: 1.4.0
+Summary: TBD
+Home-page: https://github.com/SUSE-Enceladus/csp-billing-adapter-amazon
+Author: SUSE
+Author-email: public-cloud-dev@susecloud.net
+License: Apache-2.0
+Keywords: csp-billing-adapter-amazon csp_billing_adapter_amazon
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: System :: Monitoring
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: csp-billing-adapter
+Requires-Dist: boto3
+Requires-Dist: pluggy
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: bumpversion; extra == "dev"
+Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: flake8; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# CSP Billing Adapter Amazon Plugin
+
+This is a plugin for
+[csp-billing-adapter](https://github.com/SUSE-Enceladus/csp-billing-adapter)
+that provides CSP hook implementations. This includes the hooks defined in the
+[csp_hookspecs.py module](https://github.com/SUSE-Enceladus/csp-billing-adapter/blob/main/csp_billing_adapter/csp_hookspecs.py).
+To enable metered billing in Amazon the container or instance is required to
+have MeterUsage permissions. This can be added with a role policy such as:
+
+```
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Sid": "CSPBillingAdapterPermissions",
+            "Effect": "Allow",
+            "Action": [
+                "aws-marketplace:MeterUsage"
+            ],
+            "Resource": "*"
+        }
+    ]
+}
+```
+
+## Meter billing
+
+The `meter_billing` function accepts a dictionary mapping of dimension name
+to usage quantity. This information is used to bill the customer for
+the product ID that is configured in the adapter. If there is an exception
+with metered billing the exception is raised.
+
+## Get CSP Name
+
+The `get_csp_name` function returns the name of the CSP provider. In this
+case it is *Amazon*.
+
+## Get Account Info
+
+The `get_account_info` function provides metadata information for the running
+instance or container. The structure of this information is as follows:
+
+```
+{
+    "document": {
+        "accountId": "1234567890",
+        "architecture": "x86_64",
+        "availabilityZone": "us-east-1d",
+        "billingProducts": null,
+        "devpayProductCodes": null,
+        "marketplaceProductCodes": null,
+        "imageId": "ami-1234567890abcdefg",
+        "instanceId": "i-1234567890abcdefg",
+        "instanceType": "t2.micro",
+        "kernelId": null,
+        "pendingTime": "2023-05-23T19:46:52Z",
+        "privateIp": "192.168.0.201",
+        "ramdiskId": null,
+        "region": "us-east-1",
+        "version": "2017-09-30"
+    },
+    "signature": "signature",
+    "pkcs7": "pkcs7",
+    "cloud_provider": "amazon"
+}
+```
+
+This information is pulled from the Amazon Instance metadata endpoint:
+http://169.254.169.254/latest. Note: the exact information in the
+*document* entry may vary.

csp_billing_adapter_amazon-1.4.0/README.md

@@ -0,0 +1,70 @@
+# CSP Billing Adapter Amazon Plugin
+
+This is a plugin for
+[csp-billing-adapter](https://github.com/SUSE-Enceladus/csp-billing-adapter)
+that provides CSP hook implementations. This includes the hooks defined in the
+[csp_hookspecs.py module](https://github.com/SUSE-Enceladus/csp-billing-adapter/blob/main/csp_billing_adapter/csp_hookspecs.py).
+To enable metered billing in Amazon the container or instance is required to
+have MeterUsage permissions. This can be added with a role policy such as:
+
+```
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Sid": "CSPBillingAdapterPermissions",
+            "Effect": "Allow",
+            "Action": [
+                "aws-marketplace:MeterUsage"
+            ],
+            "Resource": "*"
+        }
+    ]
+}
+```
+
+## Meter billing
+
+The `meter_billing` function accepts a dictionary mapping of dimension name
+to usage quantity. This information is used to bill the customer for
+the product ID that is configured in the adapter. If there is an exception
+with metered billing the exception is raised.
+
+## Get CSP Name
+
+The `get_csp_name` function returns the name of the CSP provider. In this
+case it is *Amazon*.
+
+## Get Account Info
+
+The `get_account_info` function provides metadata information for the running
+instance or container. The structure of this information is as follows:
+
+```
+{
+    "document": {
+        "accountId": "1234567890",
+        "architecture": "x86_64",
+        "availabilityZone": "us-east-1d",
+        "billingProducts": null,
+        "devpayProductCodes": null,
+        "marketplaceProductCodes": null,
+        "imageId": "ami-1234567890abcdefg",
+        "instanceId": "i-1234567890abcdefg",
+        "instanceType": "t2.micro",
+        "kernelId": null,
+        "pendingTime": "2023-05-23T19:46:52Z",
+        "privateIp": "192.168.0.201",
+        "ramdiskId": null,
+        "region": "us-east-1",
+        "version": "2017-09-30"
+    },
+    "signature": "signature",
+    "pkcs7": "pkcs7",
+    "cloud_provider": "amazon"
+}
+```
+
+This information is pulled from the Amazon Instance metadata endpoint:
+http://169.254.169.254/latest. Note: the exact information in the
+*document* entry may vary.

csp_billing_adapter_amazon-1.4.0/csp-billing-adapter-amazon.spec

@@ -0,0 +1,74 @@
+#
+# spec file for package csp-billing-adapter-amazon
+#
+# Copyright (c) 2023 SUSE LLC
+#
+# All modifications and additions to the file contributed by third parties
+# remain the property of their copyright owners, unless otherwise agreed
+# upon. The license for this file, and modifications and additions to the
+# file, is the same license as for the pristine package itself (unless the
+# license for the pristine package is not an Open Source License, in which
+# case the license is the MIT License). An "Open Source License" is a
+# license that conforms to the Open Source Definition (Version 1.9)
+# published by the Open Source Initiative.
+
+# Please submit bugfixes or comments via https://bugs.opensuse.org/
+#
+
+%{?sle15_python_module_pythons}
+
+Name:           csp-billing-adapter-amazon
+Version:        1.4.0
+Release:        0
+Summary:        Implements Amazon metering hooks for csp-billing-adapter
+License:        Apache-2.0
+Group:          Development/Languages/Python
+URL:            https://github.com/SUSE-Enceladus/%{name}
+Source:         https://files.pythonhosted.org/packages/source/c/%{name}/csp_billing_adapter_amazon-%{version}.tar.gz
+BuildRequires:  fdupes
+BuildRequires:  python-rpm-macros
+BuildRequires:  %{python_module csp-billing-adapter}
+BuildRequires:  %{python_module pip}
+BuildRequires:  %{python_module pluggy}
+BuildRequires:  %{python_module boto3}
+BuildRequires:  %{python_module setuptools}
+BuildRequires:  %{python_module wheel}
+%if %{with test}
+BuildRequires:  %{python_module pytest}
+BuildRequires:  %{python_module coverage}
+BuildRequires:  %{python_module pytest-cov}
+%endif
+Requires:       python-setuptools
+Requires:       python-pluggy
+Requires:       python-boto3
+Requires:       python-csp-billing-adapter
+BuildArch:      noarch
+Obsoletes:      python3-csp-billing-adapter-amazon < %{version}
+%python_subpackages
+
+%description
+Provides a plugin for csp-billing-adapter to handle
+metering of usage in Amazon AWS.
+
+%prep
+%autosetup -n csp_billing_adapter_amazon-%{version}
+
+%build
+%pyproject_wheel
+
+%install
+%pyproject_install
+%python_expand %fdupes %{buildroot}%{$python_sitelib}
+
+%check
+%if %{with test}
+%pytest
+%endif
+
+%files %{python_files}
+%license LICENSE
+%doc README.md CONTRIBUTING.md CHANGES.md
+%{python_sitelib}/csp_billing_adapter_amazon
+%{python_sitelib}/csp_billing_adapter_amazon-%{version}*-info
+
+%changelog

csp_billing_adapter_amazon-1.4.0/csp_billing_adapter_amazon/__init__.py

@@ -0,0 +1,19 @@
+#
+# Copyright 2023 SUSE LLC
+#
+# 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.
+#
+
+__author__ = """SUSE"""
+__email__ = 'public-cloud-dev@susecloud.net'
+__version__ = '1.4.0'