From 81f0ecd5c7ec7bf36662314401eecf68f61fe2e3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20G=C3=B6bel?= <dgoebel@techfak.uni-bielefeld.de>
Date: Fri, 12 Jan 2024 12:15:49 +0100
Subject: [PATCH] Add Apache 2.0 license
#6
---
LICENSE | 202 ++++++++++++++++++++++++++++++
README.md | 4 +
app/api/resource_cluster_utils.py | 2 +-
app/api/resource_s3_utils.py | 8 +-
app/s3/s3_resource.py | 17 +--
requirements.txt | 2 +-
6 files changed, 221 insertions(+), 14 deletions(-)
create mode 100644 LICENSE
diff --git a/LICENSE b/LICENSE
new file mode 100644
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/README.md b/README.md
index f381493..7561e56 100644
--- a/README.md
+++ b/README.md
@@ -34,3 +34,7 @@ This is the Resource service of the CloWM service.
| `SLURM_WORKING_DIRECTORY` | `/tmp` | Path on slurm cluster | Working directory for the slurm job with the nextflow command |
| `OPA_POLICY_PATH` | `/clowm/authz/allow` | URL path | Path to the OPA Policy for Authorization |
| `OTLP_GRPC_ENDPOINT` | unset | <hostname / IP> | OTLP compatible endpoint to send traces via gRPC, e.g. Jaeger |
+
+## License
+
+The API is licensed under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license. See the [License](LICENSE) file for more information
diff --git a/app/api/resource_cluster_utils.py b/app/api/resource_cluster_utils.py
index e3e11b1..8f3af3a 100644
--- a/app/api/resource_cluster_utils.py
+++ b/app/api/resource_cluster_utils.py
@@ -23,7 +23,7 @@ delete_resource_version_script_template = Template(filename="app/mako_templates/
tracer = trace.get_tracer_provider().get_tracer(__name__)
-async def get_async_http_client() -> AsyncGenerator[AsyncClient, None]:
+async def get_async_http_client() -> AsyncGenerator[AsyncClient, None]: # pragma: no cover
async with AsyncClient() as client:
yield client
diff --git a/app/api/resource_s3_utils.py b/app/api/resource_s3_utils.py
index c6a0c60..5d9590c 100644
--- a/app/api/resource_s3_utils.py
+++ b/app/api/resource_s3_utils.py
@@ -31,7 +31,7 @@ else:
tracer = trace.get_tracer_provider().get_tracer(__name__)
-async def get_s3_resource() -> AsyncGenerator[S3ServiceResource, None]:
+async def get_s3_resource() -> AsyncGenerator[S3ServiceResource, None]: # pragma: no cover
async with boto_session.resource(
service_name="s3",
endpoint_url=str(settings.OBJECT_GATEWAY_URI)[:-1],
@@ -58,7 +58,7 @@ async def give_permission_to_s3_resource(resource: ResourceOut) -> None:
"Condition": {"StringLike": {"s3:prefix": resource_dir_name(resource.resource_id) + "/*"}},
}
async for s3 in get_s3_resource():
- await add_s3_bucket_policy_stmt(s3=s3, bucket_name=settings.RESOURCE_BUCKET, stmt=policy)
+ await add_s3_bucket_policy_stmt(policy, s3=s3, bucket_name=settings.RESOURCE_BUCKET)
async def give_permission_to_s3_resource_version(resource_version: ResourceVersionOut, maintainer_id: str) -> None:
@@ -77,10 +77,10 @@ async def give_permission_to_s3_resource_version(resource_version: ResourceVersi
"Effect": "Allow",
"Principal": {"AWS": f"arn:aws:iam:::user/{maintainer_id}"},
"Resource": f"arn:aws:s3:::{resource_version.s3_path[5:]}",
- "Action": ["s3:DeleteObject", "s3:PutObject"],
+ "Action": ["s3:DeleteObject", "s3:PutObject", "s3:GetObject"],
}
async for s3 in get_s3_resource():
- await add_s3_bucket_policy_stmt(s3=s3, bucket_name=settings.RESOURCE_BUCKET, stmt=policy)
+ await add_s3_bucket_policy_stmt(policy, s3=s3, bucket_name=settings.RESOURCE_BUCKET)
async def add_s3_resource_version_info(s3_resource_version_info: S3ResourceVersionInfo) -> None:
diff --git a/app/s3/s3_resource.py b/app/s3/s3_resource.py
index 76328ba..a552881 100644
--- a/app/s3/s3_resource.py
+++ b/app/s3/s3_resource.py
@@ -45,7 +45,7 @@ async def load_s3_bucket_policy(s3_policy: BucketPolicy) -> Dict[str, Any]:
return {"Version": "2012-10-17", "Statement": []}
-async def add_s3_bucket_policy_stmt(s3: S3ServiceResource, bucket_name: str, stmt: Dict[str, Any]) -> None:
+async def add_s3_bucket_policy_stmt(*stmts: Dict[str, Any], s3: S3ServiceResource, bucket_name: str) -> None:
"""
Add a Statement to a bucket policy. If it doesn't exist, then create a policy.
@@ -55,16 +55,16 @@ async def add_s3_bucket_policy_stmt(s3: S3ServiceResource, bucket_name: str, stm
S3 Service to perform operations on buckets.
bucket_name : str
Name of the bucket.
- stmt : dict[str, Any]
- Statement to add to the policy.
+ stmts : dict[str, Any]
+ Statements to add to the policy.
"""
with tracer.start_as_current_span(
- "s3_add_bucket_policy_statement", attributes={"bucket_name": bucket_name, "policy_stmt": json.dumps(stmt)}
+ "s3_add_bucket_policy_statement", attributes={"bucket_name": bucket_name, "policy_stmt": json.dumps(stmts)}
):
s3_policy = await s3.BucketPolicy(bucket_name=bucket_name)
policy = await load_s3_bucket_policy(s3_policy)
-
- policy["Statement"].append(stmt)
+ for stmt in stmts:
+ policy["Statement"].append(stmt)
await s3_policy.put(Policy=json.dumps(policy))
@@ -144,8 +144,9 @@ async def delete_s3_objects(s3: S3ServiceResource, bucket_name: str, prefix: str
) as span:
bucket = await s3.Bucket(bucket_name)
deleted_objs = await bucket.objects.filter(Prefix=prefix).delete()
- deleted_keys = [obj["Key"] for obj in deleted_objs[0]["Deleted"]]
- span.set_attribute("keys", deleted_keys)
+ if len(deleted_objs) > 0:
+ deleted_keys = [obj["Key"] for obj in deleted_objs[0]["Deleted"]]
+ span.set_attribute("keys", deleted_keys)
async def upload_obj(s3: S3ServiceResource, obj_stream: BytesIO, bucket_name: str, key: str, **kwargs: Any) -> None:
diff --git a/requirements.txt b/requirements.txt
index 2b4edb3..3207bd5 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -2,7 +2,7 @@
clowmdb>=2.3.0,<2.4.0
# Webserver packages
-fastapi>=0.108.0,<0.109.0
+fastapi>=0.109.0,<0.110.0
pydantic>=2.5.0,<2.6.0
pydantic-settings>=2.1.0,<2.2.0
uvicorn>=0.25.0,<0.26.0
--
GitLab