Merge pull request #6270 from keboola/zajca/sapi-clean

CT-2247, CT-2248 cleanup sapi files, allow monorepo split

Author: zajca

.gitignore

@@ -5,21 +5,9 @@ config.php
 composer.lock
 composer.phar
 vendor
-set-env.sh
-set-env.redshift.sh
-set-env.snowflake.sh
-set-env.mysql.sh
-set-env.mixed.sh
-set-env.sharing.sh
 *.kdev4
 .kdev4
 .env
-snowflake_linux_x8664_odbc.tgz
 REVISION
 /cache
-phpunit-retry.xml
 .phpunit.result.cache
-set-env.global-search-mixed.sh
-set-env.global-search-sox.sh
-set-env.global-search.sh
-set-env.global-search-bq.sh

README.md

@@ -79,102 +79,6 @@ $exporter->exportTable('in.c-main.my-table', './in.c-main.my-table.csv', []);
 
 ```
 
-## Tests
-
-**Warning: Never run this tests on production project with real data, always create project for testing purposes!!!**
-
-*Note: For automated tests, the tests are run again three times by default if they fail. For local development this would be quite annoying,
-so you can disable this by creating new file `phpunit-retry.xml` from `phpunit-retry.xml.dist`*
-
-The main purpose of these tests is "black box" test driven development of Keboola Connection. These tests guards the API implementation.
-
-Tests should be executed against local dockerized version of [Keboola Connection](https://github.com/keboola/connection/) (private repo).
-These tests and local KBC are configured to share docker network where the Storage API and Manage API endpoints are provided. 
-These APIs are available at `http://connection-apache/` endpoint from clients tests.
-
-
-Before executing tests please install dev dependencies:
-- `docker compose build`
-- `docker compose run --rm dev composer install`
-
-Tests are divided into multiple test suites.
-
-### Common test suite
-This test suite expects following environment variables set:
- - `STORAGE_API_URL` - URL of Keboola Storage API (https://connection.keboola.com/)
- - `STORAGE_API_TOKEN` - Storage API token associated to user (Admin master token) with all permissions. There are no special requirements for project storage backend.
- - `STORAGE_API_GUEST_TOKEN` - Storage API token associated to user (Admin master token) with guest role in same project as `STORAGE_API_TOKEN`.
- - `STORAGE_API_READ_ONLY_TOKEN` - Storage API token associated to user (Admin master token) with readOnly role in same project as `STORAGE_API_TOKEN`.
- - `STORAGE_API_SHARE_TOKEN` - Storage API token associated to user (Admin master token) with share role in same project as `STORAGE_API_TOKEN`.
- - `STORAGE_API_MAINTENANCE_URL` - URL for maintenance testing (https://maintenance-testing.keboola.com/)
-
-
-You can export variables manually, or you can create and fill file `set-env.sh` as copy of attached `set-env.template.sh`.
-
-Then you can run tests:
-
-`source ./set-env.sh &&  docker compose run --rm dev vendor/bin/phpunit --testsuite common`
-
- 
-### Redshift backend test suite
-
-This test suite expects following environment variables set:
-- `STORAGE_API_URL` - URL of Keboola Storage API (https://connection.keboola.com/)
-- `STORAGE_API_TOKEN` - Storage API token associated to user (Admin master token) with all permissions. **Project must have `Redshift` set as default backend.**
-- `REDSHIFT_NODE_COUNT` - (optional) Set Redshift node count `default=1`
-
-You can export variables manually, or you can create and fill file `set-env.redshift.sh`
-as copy of attached `set-env.redshift.template.sh`.
-
-Then you can run tests:
-
-`source ./set-env.redshift.sh && docker compose run --rm dev vendor/bin/phpunit --testsuite backend-redshift-part-1`
-`source ./set-env.redshift.sh && docker compose run --rm dev vendor/bin/phpunit --testsuite backend-redshift-part-2`
-
-### Snowflake backend test suite
-This test suite expects following environment variables set:
-- `STORAGE_API_URL` - URL of Keboola Storage API (https://connection.keboola.com/)
-- `STORAGE_API_TOKEN` - Storage API token associated to user (Admin master token) with all permissions. **Project must have `snowflake` set as default backend.**
-
-
-You can run these tests in docker:
-
-`source ./set-env.snowflake.sh && docker compose run --rm dev vendor/bin/phpunit --testsuite backend-snowflake-part-1`
-`source ./set-env.snowflake.sh && docker compose run --rm dev vendor/bin/phpunit --testsuite backend-snowflake-part-2`
-
-### Mixed backend test suite
-Project can support multiple backends, this is useful for migrations from one backend to another.
-These tests require project with all backend assigned (redshift, snowflake).
-
-This test suite expects following environment variables set:
- - `STORAGE_API_URL` - URL of Keboola Storage API (https://connection.keboola.com/)
- - `STORAGE_API_TOKEN` and `STORAGE_API_LINKING_TOKEN` - Storage API token associated to user (Admin master token) with all permissions. Project must have assigned `snowflake` and `redshift` backend. STORAGE_API_TOKEN and STORAGE_API_LINKING_TOKEN have to be tokens to different project in same organization.
- - `STORAGE_API_GUEST_TOKEN` - Storage API token associated to user (Admin master token) with guest role in same project as `STORAGE_API_TOKEN`.
- - `STORAGE_API_SHARE_TOKEN` - Storage API token associated to user (Admin master token) with share role in same project as `STORAGE_API_TOKEN`.
- - `STORAGE_API_MAINTENANCE_URL` - URL for maintenance testing (https://maintenance-testing.keboola.com/)
- - `STORAGE_API_TOKEN_ADMIN_2_IN_SAME_ORGANIZATION` - Storage API token associated to project in the same organization as `STORAGE_API_TOKEN` but with different admin as `STORAGE_API_TOKEN`.
- - `STORAGE_API_TOKEN_ADMIN_3_IN_OTHER_ORGANIZATION` - Storage API token associated to other admin as `STORAGE_API_TOKEN` and project in the other organization as `STORAGE_API_TOKEN`.
-You can export variables manually or you can create and fill file `set-env.mixed.sh` as copy of attached `set-env.mixed.template.sh`.
-
-Then you can run tests:
-
-`source ./set-env.mixed.sh && docker compose run --rm dev vendor/bin/phpunit --testsuite backend-mixed'`
-
-## Running test from PHPStorm
-
-The whole test suite is quite big and it can take few hours. So it is a good idea to run just a testcase which you are interested in from PHPStorm, or you can run them from a console (using `--filter` option). 
-
-**How to set up PHPStorm for running tests:**
-- go to Settings / Languages & Frameworks / PHP
-- row CLI -> three dots
-- Plus button -> `From Docker, Vagrant, VM, WSL, Remote...`
-- Select `Docker Compose`; Service `dev-xdebug`; Environment variables define value from your `set-env.php`
-    - an easy way how to do it is copy content of `set-env.php` without `export ` prefix -> click on the icon in  Env. vars. -> click on the paste icon. It should pass all the key=value entries in the window. If it doesn't work, set them manually.
-- Set Path mappings to `<Project root> -> /code` (`<Project root>` is an absolute path to the project directory) 
-- hint: create different interpreters for different environments
-
-_Note: see [this link](https://www.jetbrains.com/help/phpstorm/configuring-remote-interpreters.html) for more information and screenshots about the description above._
-
 ## License
 
 See [LICENSE](./LICENSE) file.

docker-compose.yml

@@ -1,63 +1,14 @@
 services:
-  tests: &base
+  dev: &dev
     build:
       context: .
-    image: keboola/storage-api-tests
-    environment:
-      - STORAGE_API_URL
-      - STORAGE_API_TOKEN
-      - STORAGE_API_LINKING_TOKEN
-      - STORAGE_API_GUEST_TOKEN
-      - STORAGE_API_READ_ONLY_TOKEN
-      - STORAGE_API_SHARE_TOKEN
-      - STORAGE_API_DEFAULT_BRANCH_TOKEN
-      - STORAGE_API_REVIEWER_TOKEN
-      - STORAGE_API_SECOND_REVIEWER_TOKEN
-      - STORAGE_API_DEVELOPER_TOKEN
-      - STORAGE_API_MAINTENANCE_URL
-      - STORAGE_API_TOKEN_ADMIN_2_IN_SAME_ORGANIZATION
-      - STORAGE_API_TOKEN_ADMIN_3_IN_OTHER_ORGANIZATION
-      - MANAGE_API_TOKEN_ADMIN
-      - MANAGE_API_TOKEN_WITHOUT_SCOPE
-      - MANAGE_API_TOKEN_WITH_CREATE_PROTECTED_DEFAULT_BRANCH_TOKEN
-      - REDSHIFT_HOSTNAME
-      - REDSHIFT_USER
-      - REDSHIFT_PASSWORD
-      - REDSHIFT_NODE_COUNT
-      - SUITE_NAME
-      - TRAVIS_BUILD_ID
-      - BQ_KEY_FILE_FOR_EXTERNAL_BUCKET
-      - BQ_DESTINATION_PROJECT_SERVICE_ACC_EMAIL
-      - BQ_EXTERNAL_TABLE_GCS_BUCKET
-      - BQ_EXTERNAL_BUCKET_REGION
-      - SNOWFLAKE_HOST
-      - SNOWFLAKE_USER
-      - SNOWFLAKE_PASSWORD
-      - SNOWFLAKE_DB_PREFIX
-      - SNOWFLAKE_INBOUND_DATABASE_NAME
-      - SNOWFLAKE_PRODUCER_HOST
-      - SNOWFLAKE_PRODUCER_USER
-      - SNOWFLAKE_PRODUCER_PASSWORD
-      - SNOWFLAKE_PRODUCER_WAREHOUSE
-      - SNOWFLAKE_PRODUCER_SHARED_DATABASE
-      - SNOWFLAKE_PRODUCER_SHARE_NAME
-  dev: &dev
-    <<: *base
+    image: keboola/storage-api-client
     volumes:
       - ./:/code
-      - tools-cache:/tmp/tools-cache
 
   dev-xdebug:
     <<: *dev
     build:
       context: docker/xdebug
-    image: keboola/storage-api-tests-xdebug
+    image: keboola/storage-api-client-xdebug
     command: tail -f /dev/null
-
-networks:
-  default:
-      name: connection_api-tests
-      external: true
-
-volumes:
-  tools-cache: