From 460e0d1bee4c060be2a40d3455351942910161fa Mon Sep 17 00:00:00 2001 From: KK Date: Wed, 26 Jul 2023 08:24:36 +0200 Subject: [PATCH] Updated and renamed developer guide --- README.md | 2 +- .../developer_guide.md} | 9 +++++++-- 2 files changed, 8 insertions(+), 3 deletions(-) rename doc/{developers_guide/developers_guide.md => developer_guide/developer_guide.md} (89%) diff --git a/README.md b/README.md index 384dba63..3cc6c652 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,6 @@ Additional Information: * [Hands-on Guide (Parquet Files)](doc/hands_on/hands_on_parquet.md) * [Changelog](doc/changes/changelog.md) * [Dependencies](dependencies.md) -* [Developers Guide](doc/developers_guide/developers_guide.md) +* [Developer Guide](doc/developer_guide/developer_guide.md) [files-vs]: https://github.com/exasol/virtual-schema-common-document-files diff --git a/doc/developers_guide/developers_guide.md b/doc/developer_guide/developer_guide.md similarity index 89% rename from doc/developers_guide/developers_guide.md rename to doc/developer_guide/developer_guide.md index 47de277a..78b62bd0 100644 --- a/doc/developers_guide/developers_guide.md +++ b/doc/developer_guide/developer_guide.md @@ -4,9 +4,14 @@ This guide contains information for developers. ## Executing the Integration Tests Locally -The integration tests of this project use an S3 bucket. Using a local mock was not possible since the tested local-stack s3 implementation did not work. +The integration tests of this project use an S3 bucket. There are multiple ways to use or emulate S3 buckets: +* Real S3 buckets in the AWS cloud +* [Localstack](https://github.com/localstack/localstack) +* [MinIO](https://min.io) -Instead you need to configure the tests by creating file `test_config.properties` in the folder of `s3-document-files-virtual-schema`: +Please note that **Localstack does not work on your local machine**. + +Instead you need to fall back to using real AWS S3 buckets by configuring the tests appropriately by creating file `s3-document-files-virtual-schema/test_config.properties` with the following content: ```properties awsProfile =