You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by fa...@apache.org on 2024/01/22 16:18:32 UTC
(incubator-pekko-connectors) branch running-tests created (now f69d5d616)
This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a change to branch running-tests
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-connectors.git
at f69d5d616 add advice on how to run tests
This branch includes the following new commits:
new f69d5d616 add advice on how to run tests
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org
(incubator-pekko-connectors) 01/01: add advice on how to run tests
Posted by fa...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch running-tests
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-connectors.git
commit f69d5d61637a34f7e605acde0527dda27c17f3d2
Author: PJ Fanning <pj...@users.noreply.github.com>
AuthorDate: Mon Jan 22 17:18:27 2024 +0100
add advice on how to run tests
---
CONTRIBUTING.md | 27 ++++++++++++++++++++++-----
1 file changed, 22 insertions(+), 5 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c572ea51b..0494ccc03 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -6,11 +6,7 @@ You're always welcome to submit your PR straight away and start the discussion (
# The Pekko Community
-If you have questions about the contribution process or discuss specific issues, please interact with the community using the following resources.
-
-- [GitHub discussions](https://github.com/apache/incubator-pekko/discussions): for questions and general discussion.
-- [Pekko dev mailing list](https://lists.apache.org/list.html?dev@pekko.apache.org): for Pekko development discussions.
-- [GitHub issues](https://github.com/apache/incubator-pekko/issues): for bug reports and feature requests. Please search the existing issues before creating new ones. If you are unsure whether you have found a bug, consider asking in GitHub discussions or the mailing list first.
+If you have questions about the contribution process or discuss specific issues, we will be happy to try to help via the usual [communication channels](https://github.com/apache/incubator-pekko-connectors?tab=readme-ov-file#community).
# Contributing to Pekko Connectors
@@ -31,6 +27,27 @@ This is the process for committing code into main.
1. If the branch merge conflicts with its target, rebase your branch onto the target branch.
+## Running tests
+
+| :exclamation: Take care when running the shell scripts in this repo. |
+|-----------------------------------------------------------------------|
+
+You can run tests using [sbt](https://www.scala-sbt.org/). With this repo, you will typically be working on one connector at a time. For instance, the FTP connector is in the `ftp` folder and you can run its tests with `sbt ftp/test`. You should read the rest of this section before running these tests.
+
+This repo is for connectors that integrate with 3rd party services (e.g. AWS S3, FTP, Hive). For many connectors, you will need to use [Docker Compose](https://docs.docker.com/compose/) to start servers that the Pekko Connector tests will need to interact with. The tests don't expect to interact with live resources but instead expect to work with local services that provide the right functionality.
+
+You can get an idea of what Docker commands that you need to run tests for specific connectors by looking at the GitHub Actions workflow [check-build-test.yml](https://github.com/apache/incubator-pekko-connectors/blob/75e9a4867eec3e1c2b971eb7e13a0f0b9dbddab3/.github/workflows/check-build-test.yml#L78-L125).
+
+The Docker setup in many cases requires the use of shell scripts that are designed to run inside Docker containers and are not designed for users to be running on their own machines. Please take care when running any shell scripts in this repo.
+
+To continue with the FTP connector as an example, you will need to run this [script](https://github.com/apache/incubator-pekko-connectors/blob/main/scripts/ftp-servers.sh) (that runs Docker Compose commands) before running the tests.
+
+```
+./scripts/ftp-servers.sh
+```
+
+This FTP setup does not work well on Apple Macs. There is a workaround described by Sebastien Alfers in this [write up](https://github.com/sebastian-alfers/commons-net/blob/1cd10e1da577d5f900c5e33af2a041de1361eb25/README_REPRODUCE.md#squid--ftp-on-mac).
+
## Pekko Connectors specific advice
We've collected a few notes on how we would like Pekko Connectors modules to be designed based on what has evolved so far.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org