RELEASE_TESTING.MD

Release testing

Before releasing a new version of KtLint, the release candidate is tested on a selection of open source projects to improve the quality of the release, and the documentation is tested for dead links.

Setup infrastructure

1. Create a directory in which the projects are grouped:

   mkdir sample-projects
   cd sample-projects

2. In the sample-projects directory, create a shell command script exec-in-each-project.sh with content below. This script is used to run the same command in each of the sample projects:

   # Examples of usage
   #
   #   Outstanding changes per project
   #     ./exec-in-each-project.sh "git status"
   #
   #   Rollback outstanding changes per project
   #     ./exec-in-each-project.sh "git reset --hard"
   #
   #   Run ktlint standard rules
   #     ktlint --version && ktlint "**/*.kt" -v --relative -F
   #
   #   Commit changes of standard rules:
   #     ./exec-in-each-project.sh "git commit -m \"ktlint (0.43.2) -F\""
   
   find . -maxdepth 1 -type d \( ! -name . \) -exec bash -c "cd '{}' && pwd && $@" \;

3. Clone the repositories of the sample projects (feel free to change this selection):

   git clone https://github.com/google/iosched.git
   git clone https://github.com/android/uamp.git
   git clone https://github.com/siempredelao/StaticAnalysisTest
   git clone https://github.com/Kotlin/kotlinx.coroutines.git
   git clone https://github.com/square/okhttp.git
   git clone https://github.com/detekt/detekt.git
   git clone https://github.com/ExpediaGroup/graphql-kotlin.git
   git clone https://github.com/Kotlin/kotlinx.serialization.git

4. Create an alias or script to run the latest released version of ktlint (note that this script will print the version as reference to which version is used):

   alias ktlint-prev="ktlint-0.47.1 $@" # Replace with the latest release version

   Note that ~/git/ktlint is the directory in which the ktlint project is checked out and that ~/git/ktlint/ktlint refers to the ktlint CLI-module.
5. Create an alias or script to run the latest development-version of ktlint (note that this script will print the version and the datetime of compilation as reference to which version is used):

   alias ktlint-dev="echo 'ktlint-dev version:';ls -aslh ~/git/ktlint/ktlint/build-cli/run/ktlint;echo ' ';~/git/ktlint/ktlint/build/run/ktlint $@"

   Note that ~/git/ktlint is the directory in which the ktlint project is checked out and that ~/git/ktlint/ktlint refers to the ktlint CLI-module.

Cleanup from previous testing

1. Reset the repositories of the sample projects:

   ./exec-in-each-project.sh "git reset --hard origin"

2. Optionally, pull latest changes of the sample projects:

   ./exec-in-each-project.sh "git pull"

3. Remove baseline file

   rm baseline.xml

Testing a new release

Pre-requisites:

• All changes have been merged to master.
• Latest version of master has been pulled to the local machine.
• The latest released version of ktlint matches with command ktlint:

  ktlint-prev --version

• The latest version of master has been build on the local machine. And it is verified that the datetime of ktlint-dev (more or less) matches with the datetime of this compilation.

  ktlint-dev --version

Formatting projects in which ktlint is not used may result in a huge amount of fixes. The main focus of this test is to see what the effects are when upgrading ktlint in a project already formatted with latest released ktlint version.

1. Format the sample projects with the latest released ktlint version:

   ktlint-prev -F --relative # Do not call this command via the "./exec-in-each-project.sh" script.

   Note: Ignore all output as this is the old version!
2. Commit changes:

   ./exec-in-each-project.sh "git add --all && git commit -m \"Format with ktlint (xx.yy.zz) -F\""

   Repeat step 1 and 2 until no files are changed anymore.
3. Create a new baseline file with the latest released ktlint version to ignore all lint violations that could not be autocorrected using the latest ktlint version:

   rm baseline.xml
   ktlint-prev --baseline=baseline.xml --relative # Do not call this command via the "./exec-in-each-project.sh" script as we want one combined baseline.xml file for all projects.

4. Check that besides the baseline.xml no files are changed (in step 1 and 2 all violations which could be autocorrected have already been committed). Remaining violations which could not be autocorrected are saved in the baseline.xml which is stored outside the project directories.

   ./exec-in-each-project.sh "git status"

   The baseline.xml file should only contain errors which can not be autocorrected.
5. Define .editorconfig in the integration test directory with content below. Also follow up the instructions mentioned:

   root = true
   [*.{kt,kts}]
   # The open source projects that are used for release testing of ktlint contain a few '.editorconfig' files which need to
   # be changed:
   #   1) Disable the "root = true" property so that each project ultimately falls back on this file. In this way offending
   #      rules can be easily enabled/disabled for all test projects
   #   2) Add specific rules to project below
   #        graphql
   #          ktlint_standard_import-ordering = disabled
   #          ktlint_standard_package-name = disabled
   ktlint_experimental = enabled
   ktlint_standard = enabled
   ktlint_standard_filename = disabled
   ktlint_standard_no-wildcard-imports = disabled
   ktlint_standard_function-naming = disabled
   ktlint_standard_property-naming = disabled

6. Commit changes:

   ./exec-in-each-project.sh "git add --all && git commit -m \"Update .editorconfig to fallback to integration test settings\""

7. Lint with latest development version:

   ktlint-dev --baseline=baseline.xml --relative # Do not call this command via the "./exec-in-each-project.sh" script as we want to use the one combined baseline.xml file for all projects.
   # or when lots are violations are reported
   ktlint-dev --baseline=baseline.xml --relative --reporter=plain-summary # Do not call this command via the "./exec-in-each-project.sh" script as we want to use the one combined baseline.xml file for all projects.

   Inspect the output roughly (detailed inspection is done when formatting):
   • Is the amount of logging messages comparable to before? If not, are the changes intended?
   • Are violations related to rules that have actually been added or changed?
8. Format with latest development version:

   ktlint-dev -F --baseline=baseline.xml --relative # Do not call this command via the "./exec-in-each-project.sh" script as we want to use the one combined baseline.xml file for all projects.

   Inspect the output carefully:
   • If you see an error like below, then this version obviously may not be released. It is best to fix this error before continuing with testing and validating!

     Internal Error (...) in file '...' at position '0:0. Please create a ticket at https://github.com/pinterest/ktlint/issues ...
     

   • Ideally, no violations are shown. This means that all violations have been autocorrected.
   • Violations which could not be autocorrected should be validated for correctness but do not block the release as most likely this is intended behavior.
   • If a violation is shown which is not marked as being "can not be autocorrected" this means that during autocorrect of another violation a new violations has been introduced. This should be fixed before releasing especially when the next format introduces the original violation again which of course would result in an endless loop.
9. Inspect all fixed violations, Of course inspection similar violations tens of times does not make sense. At least check different types of violations a couple of times. Commit changes which do not need to be inspected again:

   ./exec-in-each-project.sh "git add --all && git commit -m \"Fixed with latest development version\""

10. Rerun lint with latest development version:

    ktlint-dev --baseline=baseline.xml --relative # Do not call this command via the "./exec-in-each-project.sh" script as we want to use the one combined baseline.xml file for all projects.

    No violations, except error that can not be autocorrected, should be expected.

Checking documentation

The documentation for KtLint should be checked for dead links. Follow the instructions for building the documentation in /docs/readme.md, and use a tool such as Broken Link Checker Tool to find broken links.