build: configure and document direnv (#19)

Rely on direnv to set up environment variables and fall back to "regular" Maven usage for running end-to-end tests.

Co-authored-by: Ali Ince <ali-ince@users.noreply.github.com>

Author: fbiville

.envrc

@@ -0,0 +1,8 @@
+export BROKER_EXTERNAL_HOST="localhost:9092"
+export SCHEMA_CONTROL_REGISTRY_URI="http://schema-registry:8081"
+export SCHEMA_CONTROL_REGISTRY_EXTERNAL_URI="http://localhost:8081"
+export KAFKA_CONNECT_EXTERNAL_URI="http://localhost:8083"
+export NEO4J_URI="neo4j://neo4j"
+export NEO4J_EXTERNAL_URI="neo4j://localhost"
+export NEO4J_USER="neo4j"
+export NEO4J_PASSWORD="password"

README.md

@@ -31,17 +31,33 @@ Then add the following content into `settings/servers` inside ~/.m2/settings.xml
 
 ### Build locally
 
-You can build and package the project using;
+Make sure you install [dip](https://github.com/bibendi/dip) and [direnv](https://direnv.net/).
 
+For the end-to-end tests, you need to provision a local Kafka cluster, Kafka Connect instance and a Neo4j server.
+This is done by running (re-running recreates the containers):
+
+```shell
+dip provision
+```
+
+Make sure `direnv` exports environment variables by running:
+```shell
+direnv allow .
 ```
-mvn clean package
+
+You can build and package the project using (as many as time as necessary):
+
+```shell
+mvn verify
 ```
 
 You'll find the connector archive
 at `kafka-connect-neo4j/target/components/packages/neo4j-kafka-connect-neo4j-{version}.zip`.
 
 ### Code Format
 
+TL;DR? You can run `dip format`.
+
 For Kotlin code, we follow the [ktfmt](https://github.com/facebook/ktfmt) code style. There is an `.editorconfig` file
 to mimic the underlying style guides for built-in Intellij code style rules, but we recommend
 [ktfmt IntelliJ Plugin](https://plugins.jetbrains.com/plugin/14912-ktfmt) for formatting. Remember that your builds will

dip.yml

@@ -19,21 +19,6 @@ interaction:
         find ./docker/plugins ! -name '.keep' -type f -exec rm -f {} + && 
         cp ./packaging/target/*.jar ./docker/plugins"
 
-  run-e2e:
-    description: verify connector packages
-    runner: local
-    command: >
-      sh -c "./mvnw verify -DskipUnitTests"
-    environment:
-      BROKER_EXTERNAL_HOST: "localhost:9092"
-      SCHEMA_CONTROL_REGISTRY_URI: "http://schema-registry:8081"
-      SCHEMA_CONTROL_REGISTRY_EXTERNAL_URI: "http://localhost:8081"
-      KAFKA_CONNECT_EXTERNAL_URI: "http://localhost:8083"
-      NEO4J_URI: "neo4j://neo4j"
-      NEO4J_EXTERNAL_URI: "neo4j://localhost"
-      NEO4J_USER: "neo4j"
-      NEO4J_PASSWORD: "password"
-
   stop-connect:
     description: stops connect container
     service: connect