From 7703795ff73a413ef4e6aba2afb939b3b7555afe Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=81ukasz=20Bia=C5=82y?= <lukasz.marcin.bialy@gmail.com>
Date: Sun, 21 Jul 2024 20:43:09 +0200
Subject: [PATCH] improved integration tests a little bit further

---
 .gitignore                               | 5 ++++-
 integration-tests/README.md              | 8 +++++++-
 integration-tests/downloadYamlConfigs.sh | 3 ++-
 3 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/.gitignore b/.gitignore
index 4f05bd83a..84ac4e06e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -38,10 +38,13 @@ target/
 # test files
 *.tml
 *.yaml
-tests/repositories/
+integration-tests/repositories/
 
 #general
 *.class
 *.log
 
 generated-docs
+
+# java=17.0.9-graalce if you use sdkman
+.sdkmanrc 
\ No newline at end of file
diff --git a/integration-tests/README.md b/integration-tests/README.md
index 73bed4001..a81b687e4 100644
--- a/integration-tests/README.md
+++ b/integration-tests/README.md
@@ -1,3 +1,9 @@
 ### Test suite
 
-Yaml test suite are used in integration testing - https://github.com/yaml/yaml-test-suite
\ No newline at end of file
+Yaml test suite are used in integration testing - https://github.com/yaml/yaml-test-suite
+
+#### How to run integration tests
+
+1. Figure out if `yamlpp-events` is installed on your system or install it if not, it's perl's yaml pp module
+2. Run `downloadYamlConfigs.sh` script to download yaml test suites
+3. `sbt integration/test` to run tests
\ No newline at end of file
diff --git a/integration-tests/downloadYamlConfigs.sh b/integration-tests/downloadYamlConfigs.sh
index 9e2debeff..3c9f4971c 100755
--- a/integration-tests/downloadYamlConfigs.sh
+++ b/integration-tests/downloadYamlConfigs.sh
@@ -29,7 +29,8 @@ done
 mkdir -p ./src/test/resources/yaml/configs/
 find ./repositories -name '*.yaml' -exec cp -prv '{}' './src/test/resources/yaml/configs/' ';'
 
-LIB_YAML_PATH="" # Set the path to libyaml
+# lbialy: I think the process used here is 'yamlpp-events' so `which yamlpp-events` should be used
+LIB_YAML_PATH=`which yamlpp-events` # Set the path to libyaml
 
 # In downloaded repositories contains some invalid yaml, below instructions can remove this yaml
 for f in ./src/test/resources/yaml/configs/*.yaml; do