| Name | osml-tile-server-test JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Package to run tests against osml-tile-server deployments. |
| upload_time | 2024-04-04 20:35:27 |
| maintainer | None |
| docs_url | None |
| author | Amazon Web Services |
| requires_python | >=3.9 |
| license | MIT No Attribution Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# OSML Tile Server Test
This package contains the integration tests for OSML Tile Server application
### Table of Contents
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation Guide](#installation-guide)
* [Documentation](#documentation)
* [Running Tests in Docker](#running-tests-in-docker)
* [Running LoadTest](#running-loadtest)
* [Support & Feedback](#support--feedback)
* [Security](#security)
* [License](#license)
## Getting Started
### Prerequisites
First, ensure you have installed the following tools locally
1. [aws cli](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)
2. [docker](https://nodejs.org/en)
3. [tox](https://tox.wiki/en/latest/installation.html)
### Installation Guide
1. Clone `osml-tile-server-test` package into your desktop
```sh
git clone https://github.com/aws-solutions-library-samples/osml-tile-server-test.git
```
1. Run `tox` to create a virtual environment
```sh
cd osml-tile-server-test
tox
```
### Documentation
You can find documentation for this library in the `./doc` directory. Sphinx is used to construct a searchable HTML
version of the API documents.
```shell
tox -e docs
```
### Running Tests
#### In AWS Lambda
The Tile Server Test package is designed to be deployed as an AWS Lambda Container.
The [osml-cdk-constructs](https://github.com/aws-solutions-library-samples/osml-cdk-constructs)
package contains the required resources, and example stacks can be found in the associated
[AWS Guidance Repository](https://github.com/aws-solutions-library-samples/guidance-for-processing-overhead-imagery-on-aws).
When deployed in this manner, the Tile Server integration tests can be initiated by running ```npm run integ:tile-server```
from the guidance repository.
#### In Docker
For testing and development purposes, the Tile Server tests can be executed locally in Docker.
Arguments can be passed to docker run to configure the endpoint, test type, source bucket, and source image.
If testing against a local tile server, ```--network host``` may need to be added as a ```docker run``` flag.
Example Build:
```sh
docker build . -t tile-server-test:latest
```
Example Integration test:
```sh
docker run --name osml-tile-server-test --rm tile-server-test:latest --endpoint <Endpoint URL> --test_type integ --source_image_bucket <S3 bucket> --source_image_key <S3 Image Key> -v
```
Example Locust Load test (Default UI address is http://localhost:8089):
```sh
docker run --name osml-tile-server-test --rm tile-server-test:latest --endpoint <Endpoint URL> --test_type load --source_image_bucket <S3 bucket> --locust_image_keys <S3 Image Key>,<S3 Image Key> -v
```
Other optional load test flags are:
- ```--locust_headless <true/false>``` Disable the web interface, and start the test immediately. Default: False
- ```--locust_users <number>``` Load Test: Peak number of concurrent Locust users.
- ```--locust_run_time <string>``` Stop after the specified amount of time, e.g. (300s, 20m, 3h, 1h30m, etc.)
- ```--locust_spawn_rate <string>``` Rate to spawn users at (users per second).
## Support & Feedback
To post feedback, submit feature ideas, or report bugs, please use the [Issues](https://github.com/aws-solutions-library-samples/osml-tile-server-test/issues) section of this GitHub repo.
If you are interested in contributing to OversightML Model Runner, see the [CONTRIBUTING](CONTRIBUTING.md) guide.
## Security
See [CONTRIBUTING](CONTRIBUTING.md) for more information.
## License
MIT No Attribution Licensed. See [LICENSE](LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "osml-tile-server-test",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Amazon Web Services",
"author_email": "aws-osml-admin@amazon.com",
"download_url": "https://files.pythonhosted.org/packages/1a/ac/c74e575fdf6d05e742c4a33f94a9efc9bda22724093164f0e50a32f1a250/osml-tile-server-test-0.1.0.tar.gz",
"platform": null,
"description": "# OSML Tile Server Test\n\nThis package contains the integration tests for OSML Tile Server application\n\n### Table of Contents\n* [Getting Started](#getting-started)\n * [Prerequisites](#prerequisites)\n * [Installation Guide](#installation-guide)\n * [Documentation](#documentation)\n * [Running Tests in Docker](#running-tests-in-docker)\n * [Running LoadTest](#running-loadtest)\n* [Support & Feedback](#support--feedback)\n* [Security](#security)\n* [License](#license)\n\n\n## Getting Started\n### Prerequisites\n\nFirst, ensure you have installed the following tools locally\n\n1. [aws cli](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)\n2. [docker](https://nodejs.org/en)\n3. [tox](https://tox.wiki/en/latest/installation.html)\n\n### Installation Guide\n\n1. Clone `osml-tile-server-test` package into your desktop\n\n```sh\ngit clone https://github.com/aws-solutions-library-samples/osml-tile-server-test.git\n```\n\n1. Run `tox` to create a virtual environment\n\n```sh\ncd osml-tile-server-test\ntox\n```\n\n### Documentation\n\nYou can find documentation for this library in the `./doc` directory. Sphinx is used to construct a searchable HTML\nversion of the API documents.\n\n```shell\ntox -e docs\n```\n\n### Running Tests\n\n#### In AWS Lambda\nThe Tile Server Test package is designed to be deployed as an AWS Lambda Container.\nThe [osml-cdk-constructs](https://github.com/aws-solutions-library-samples/osml-cdk-constructs)\npackage contains the required resources, and example stacks can be found in the associated\n[AWS Guidance Repository](https://github.com/aws-solutions-library-samples/guidance-for-processing-overhead-imagery-on-aws).\nWhen deployed in this manner, the Tile Server integration tests can be initiated by running ```npm run integ:tile-server```\nfrom the guidance repository.\n\n#### In Docker\nFor testing and development purposes, the Tile Server tests can be executed locally in Docker.\nArguments can be passed to docker run to configure the endpoint, test type, source bucket, and source image.\nIf testing against a local tile server, ```--network host``` may need to be added as a ```docker run``` flag.\n\nExample Build:\n```sh\ndocker build . -t tile-server-test:latest\n```\nExample Integration test:\n```sh\ndocker run --name osml-tile-server-test --rm tile-server-test:latest --endpoint <Endpoint URL> --test_type integ --source_image_bucket <S3 bucket> --source_image_key <S3 Image Key> -v\n```\nExample Locust Load test (Default UI address is http://localhost:8089):\n```sh\ndocker run --name osml-tile-server-test --rm tile-server-test:latest --endpoint <Endpoint URL> --test_type load --source_image_bucket <S3 bucket> --locust_image_keys <S3 Image Key>,<S3 Image Key> -v\n```\nOther optional load test flags are:\n\n- ```--locust_headless <true/false>``` Disable the web interface, and start the test immediately. Default: False\n- ```--locust_users <number>``` Load Test: Peak number of concurrent Locust users.\n- ```--locust_run_time <string>``` Stop after the specified amount of time, e.g. (300s, 20m, 3h, 1h30m, etc.)\n- ```--locust_spawn_rate <string>``` Rate to spawn users at (users per second).\n\n\n\n## Support & Feedback\n\nTo post feedback, submit feature ideas, or report bugs, please use the [Issues](https://github.com/aws-solutions-library-samples/osml-tile-server-test/issues) section of this GitHub repo.\n\nIf you are interested in contributing to OversightML Model Runner, see the [CONTRIBUTING](CONTRIBUTING.md) guide.\n\n## Security\n\nSee [CONTRIBUTING](CONTRIBUTING.md) for more information.\n\n## License\n\nMIT No Attribution Licensed. See [LICENSE](LICENSE).\n",
"bugtrack_url": null,
"license": " MIT No Attribution Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Package to run tests against osml-tile-server deployments.",
"version": "0.1.0",
"project_urls": {
"Source": "https://github.com/aws-solutions-library-samples/osml-tile-server-test",
"Tracker": "https://github.com/aws-solutions-library-samples/osml-tile-server-test/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6c1614a0954ad43ce010ea54a0647fc6374892728a6f42e2adc36a11d4e674a0",
"md5": "293d92fbb1e1bdde4525c4c540706678",
"sha256": "6cc8a5edc4a835aef79ce01c1bee8d9abf2370ab10ed93b57eca808cd0989d60"
},
"downloads": -1,
"filename": "osml_tile_server_test-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "293d92fbb1e1bdde4525c4c540706678",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 22452,
"upload_time": "2024-04-04T20:35:26",
"upload_time_iso_8601": "2024-04-04T20:35:26.108608Z",
"url": "https://files.pythonhosted.org/packages/6c/16/14a0954ad43ce010ea54a0647fc6374892728a6f42e2adc36a11d4e674a0/osml_tile_server_test-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1aacc74e575fdf6d05e742c4a33f94a9efc9bda22724093164f0e50a32f1a250",
"md5": "3dc93e4198db078e1a52d6ea23c2d791",
"sha256": "e3fb173fd5cd597335665d86b77358aa5f2f779e4c4a730add7d534aca261916"
},
"downloads": -1,
"filename": "osml-tile-server-test-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3dc93e4198db078e1a52d6ea23c2d791",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 16180,
"upload_time": "2024-04-04T20:35:27",
"upload_time_iso_8601": "2024-04-04T20:35:27.944769Z",
"url": "https://files.pythonhosted.org/packages/1a/ac/c74e575fdf6d05e742c4a33f94a9efc9bda22724093164f0e50a32f1a250/osml-tile-server-test-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 20:35:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws-solutions-library-samples",
"github_project": "osml-tile-server-test",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "osml-tile-server-test"
}
