Issue #866: Convert project-to-test into yaml

checkstyle · May 28, 2024 · 46d6a6c · 46d6a6c
1 parent 33c184b
commit 46d6a6c
Show file tree

Hide file tree

Showing 6 changed files with 450 additions and 68 deletions.
diff --git a/appveyor.yml b/appveyor.yml
@@ -74,15 +74,15 @@ environment:
       CMD3: " && cd checkstyle && git checkout -b patch-branch"
       CMD4: " "
       CMD5: " && cd ..\\checkstyle-tester "
-      CMD6: " && groovy diff.groovy -l projects-to-test-on.properties -c my_check.xml -b master -p patch-branch -r C:\\projects\\contribution\\checkstyle -s"
+      CMD6: " && groovy diff.groovy -l projects-to-test-on.yml -c my_check.xml -b master -p patch-branch -r C:\\projects\\contribution\\checkstyle -s"
     - JAVA_HOME: C:\Program Files\Java\jdk11
       DESC: "checkstyle-tester (diff.groovy with base and patch configs) on guava"
       CMD1: " git clone -q --depth=10 --branch=master "
       CMD2: "      https://github.com/checkstyle/checkstyle C:\\projects\\contribution\\checkstyle "
       CMD3: " && cd checkstyle && git checkout -b patch-branch"
       CMD4: " "
       CMD5: " && cd ..\\checkstyle-tester "
-      CMD6: " && groovy diff.groovy -l projects-to-test-on.properties -bc my_check.xml -pc my_check.xml -b master -p patch-branch -r C:\\projects\\contribution\\checkstyle -s"
+      CMD6: " && groovy diff.groovy -l projects-to-test-on.yml -bc my_check.xml -pc my_check.xml -b master -p patch-branch -r C:\\projects\\contribution\\checkstyle -s"
 
 build_script:
   - ps: >

diff --git a/checkstyle-tester/README.md b/checkstyle-tester/README.md
@@ -209,7 +209,7 @@ the custom configuration created with all the permutations.
 ```bash
 groovy diff.groovy --localGitRepo /home/johndoe/projects/checkstyle \
   --baseBranch i111-my-fix --patchBranch i111-my-fix-mutation \
-  --config config.xml --listOfProjects projects-to-test-on.properties
+  --config config.xml --listOfProjects projects-to-test-on.yml
 ```
 
 ATTENTION:

diff --git a/checkstyle-tester/README_MANUAL_EXECUTION.md b/checkstyle-tester/README_MANUAL_EXECUTION.md
@@ -114,14 +114,14 @@ that specify the report you want generated.
 ```bash
 groovy diff.groovy --localGitRepo /home/johndoe/projects/checkstyle \
   --baseBranch master --patchBranch i111-my-fix --config my_check.xml \
-  --listOfProjects projects-to-test-on.properties
+  --listOfProjects projects-to-test-on.yml
 ```
 
 or with short command line arguments names:
 
 ```bash
 groovy diff.groovy -r /home/johndoe/projects/checkstyle \
-  -b master -p i111-my-fix -c my_check.xml -l projects-to-test-on.properties
+  -b master -p i111-my-fix -c my_check.xml -l projects-to-test-on.yml
 ```
 
 #### Difference Report with Different Base and Patch Config
@@ -132,14 +132,14 @@ patch branch use the following command:
 ```bash
 groovy diff.groovy --localGitRepo /home/johndoe/projects/checkstyle \
   --baseBranch master --patchBranch i111-my-fix --baseConfig base_config.xml \
-  --patchConfig patch_config.xml --listOfProjects projects-to-test-on.properties
+  --patchConfig patch_config.xml --listOfProjects projects-to-test-on.yml
 ```
 
 or with short command line arguments names:
 
 ```bash
 groovy diff.groovy -r /home/johndoe/projects/checkstyle -b master -p i111-my-fix \
-  -bc base_config.xml -pc patch_config.xml -l projects-to-test-on.properties
+  -bc base_config.xml -pc patch_config.xml -l projects-to-test-on.yml
 ```
 
 #### Basic Single Report
@@ -150,14 +150,14 @@ use the following command:
 ```bash
 groovy diff.groovy --localGitRepo /home/johndoe/projects/checkstyle --patchBranch \
   i111-my-fix --patchConfig patch_config.xml \
-  --listOfProjects projects-to-test-on.properties --mode single`
+  --listOfProjects projects-to-test-on.yml --mode single`
 ```
 
 or with short command line arguments names:
 
 ```bash
 groovy diff.groovy -r /home/johndoe/projects/checkstyle -p i111-my-fix \
-  -pc patch_config.xml -l projects-to-test-on.properties -m single
+  -pc patch_config.xml -l projects-to-test-on.yml -m single
 ```
 
 ## Deploying Report

diff --git a/checkstyle-tester/multi_config_check_regression.groovy b/checkstyle-tester/multi_config_check_regression.groovy
@@ -36,11 +36,11 @@ static void main(String[] args) {
         def configFilesDir = cliOptions.configDir
         def outputDirectory = cliOptions.outputDir
         def patchBranch = cliOptions.patchBranch
-        def projectsToTestOn = new File("projects-to-test-on.properties")
+        def projectsToTestOn = new File("projects-to-test-on.yml")
 
         println "Running check regression reports for patch branch: ${patchBranch}."
         println "Make sure that you have selected (uncommented)" +
-            " correct projects from projects-to-test-on.properties!"
+            " correct projects from projects-to-test-on.yml!"
 
         def reportDirectoryName =
             java.time.LocalDate.now().toString() + "_" + patchBranch + "_reports";