Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update dependency com.lemonappdev:konsist to v0.13.0 #99

Merged
merged 1 commit into from
Oct 9, 2023
Merged

Update dependency com.lemonappdev:konsist to v0.13.0 #99

merged 1 commit into from
Oct 9, 2023

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Oct 9, 2023 •
edited
Loading

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
com.lemonappdev:konsist (source) 0.12.2 -> 0.13.0 age adoption passing confidence

Release Notes

LemonAppDev/konsist (com.lemonappdev:konsist)

v0.13.0

What's Changed

This release focuses on improving KoTest support and improve assertions.

image

From this point, Konsit will have a first-class KoTest support meaning that every following release will be developed with KoTest support in mind. At the moment we have addressed known issues and improved the API. If you think something is still missing just let us know on Slack. We would like to add more KoTest snippets to our documentation, but first, we want to see how you are using Konsist with KoTest (let us know).

On top of that, we have introduced, new assertions, multiple improvements and bug fixes (thanks to your feedback🙏).

Some of our efforts happen in the background. For instance, we improve documentation are enhance the CI setup and release process to facilitate a more frequent release schedule. Additionally, we aim to make the Konsist backlog and roadmap public to boost transparency and community involvement.

Big claps go towards @​JonathanSarco for his open-source contributions to the Konsist codebase 👏.

1. Improved Assertions
Konsist
  .scopeFromProject()
  .classes()
  .assertTrue { ... } //  previously assert { ... }

Konsist
  .scopeFromProject()
  .classes()
  .assertFalse { ... } //  previously assertNot { ... }

We have relaxed the empty list behavior. Konsist test will pass on an empty list to match the behavior of methods in Kotlin collection processing:

Konsist
  .scopeFromProject()
  .classes()
  .filter { it.name == "non existing class name" } 
  .assertTrue { ... } // no crash

We have also added a strict parameter to restore old behavior:

Konsist
  .scopeFromProject()
  .classes()
  .filter { it.name == "non existing class name" } 
  .assertTrue(strict = true) { ... } // crash

The assertTrue and assertFalse can be called on a single declaration:

Konsist
  .scopeFromProject()
  .classes()
  .first()
  .assertTrue { ... }

Konsist
  .scopeFromProject()
  .classes()
  .first()
  .assertFalse { ... }

We have added new assertions. Now you can verify if certain queries result in empty or non-empty lists with assertEmpty() and assertNotEmpty():

Konsist
  .scopeFromPackage("..data..")
  .classes()
  .assertEmpty()

Konsist
  .scopeFromPackage("..data..")
  .classes()
  .assertNotEmpty()

You can now check whether a specific query is invoked on a null or non-null declaration.

Konsist
  .scopeFromProject()
  .classes()
  .first()
  .assertNull()

Konsist
  .scopeFromProject()
  .classes()
  .first()
  .assertNotNull()

The assertArchitecture assertion on the list of files (previously it worked only on KoScope):

// Works as before
Konsist
  .scopeFromProject()
  .assertArchitecture { ... } 

// Now files can be further processed before asserting architecture
Konsist
  .scopeFromProject()
  .files
  .filter { ... }
  .assertArchitecture { ... }

The additionalMessage param allows to provision of additional messages that will be displayed with the failing test. This may be a more detailed description of the problem or a hint on how to fix the issue:

Konist
    .scopeFromProject() 
    .classes()
    .assertFalse(additionalMessage = "Do X to fix the issue") { ... }
2. Improved KoTest Support

We've allowed assertions for individual declaration (previously list of declarations was required).

Konsist
   .scopeFromProject()
   .classes()
   .first()
   .assertTrue { }  // now possible

Due to Kotlin/JVM limitation, the test name has to be passed manually for each KoTest test. We have added a dedicated testName argument (assertTrue and assertFalse methods). The test name is used in two ways - as a test name displayed in the failing test crash and as a suppressName used for suppressing tests. While this solution may not be perfect (unlike JUnit tests which don't require this), it's still effective and works well. We are open to making it better, but ATM we are stuck. The upcoming The K2 Compiler may provide a more convenient alternative.

With the new testName parameter the KoTest test can be now suppressed:

Konsist
 .scopeFromProject()
 .classes()
 .assert(testName = "custom suppress name") { ... }

// Suppression by custom name passed as an argument
@​Suppress("custom supress name")
class Car {

}

// Suppression by custom name passed as argument also works with `konsist.` prefix
// This prefix does not have to be explicitly specified for the `testName` argument
@​Suppress("konsist.custom supress name")
class Car {

}

We have added multiple KoTest starter projects. Each project has Konsist and KoTest preconfigured configured and a single KoTest test:

  • konsist-starter-android-gradle-groovy-kotest
  • konsist-starter-android-gradle-kotlin-kotest
  • konsist-starter-kmp-gradle-kotlin-kotest
  • konsist-starter-spring-gradle-groovy-kotest
  • konsist-starter-spring-gradle-kotlin-kotest

We have also updated snippets to include a few KoTest examples (help us with adding a few more). The entire Konsist documentation was updated to take KoTest into consideration.

3. Added support for getters & setters

Now Konsist will allow to access and verify setters and getters. For example, now it is possible to verify if a given property has a getter (or setter):

 Konsist
    .scopeFromProject()
    .properties()
    .assertTrue { it.hasGetter && it.hasSetter} 
 Konsist
    .scopeFromProject()
    .properties()
    .getters
    .assertTrue { it.hasBlockBody }
4. Ability to check block body and expression body

With declarations such as functions, getters, and setters you can now they the type of the body (block or expression):

Konsist
   .scopeFromProject()
   .functions()
   .assertTrue { it.hasExpressionBody} 
 Konsist
    .scopeFromProject()
    .properties()
    .getters
    .assertTrue { it.hasBlockBody }
5. Ability to check return value

You can check if functions have a return value:

Konsist
   .scopeFromProject()
   .functions()
   .assertTrue { it.hasReturnValue }

You can inspect return value further

Konsist
            .scopeFromProject()
            .functions()
            .assertTrue { it.returnType?.text == "Unit" || it.returnType?.text == null}
6. Ability to inspect property value

You can check if properties have a value:

Konsist
    .scopeFromProject()
    .properties()
    .assertTrue { it.hasValue() }

Assert if property has a given value:

Konsist
    .scopeFromProject()
    .properties()
    .assertTrue { it.value.startsWith("prefix") }

Filter properties with given value:

Konsist
    .scopeFromProject()
    .properties()
    .withValue { it.startsWith(“prefix”) }
    .assertTrue { ... }
7. Added withName/withoutName with predicate parameter

Now it is possible to call withName and withoutName with the specified predicate:

Konsist
    .scopeFromProject()
    .properties()
    .withName { it.startsWith(“prefix”) || it.endsWith(“suffix”) }
    .assertTrue { ... }
8. Improved hasX methods

We have deprecated all containsX methods and instead added some methods with has prefixes (like hasX, hasAllX etc.):

Konsist
    .scopeFromProject()
    .interfaces()
    .assertTrue { it.hasClasses() }
Konsist
    .scopeFromProject()
    .classes()
    .assertTrue { it.hasProperty { prop -> prop.hasValue() } }
Konsist
    .scopeFromProject()
    .classes()
    .assertTrue { it.hasAllProperties { prop -> prop.hasValue() } }
9. Improved Scope Creation

We are continuing our exploration of JGit and other APIs to enhance various development workflows e.g. a way to run Konsist Tests only on files modified in a given PR. We have added a new way of creating the scope:

// Create scope from paths
Konsist.scopeFromFiles("Repository.kt", "path\UseCase.kt")

// Create scope from set of paths
val paths = setOf("Repository.kt", "path\UseCase.kt")
Konsist.scopeFromFiles(paths)

10. What’s Next?

We are hearing the community feedback. The top 1 requested feature is the declaration references. We want to enable a way to retrieve parents (of a given class/interface/companion object) as Konsist declarations, rather than string names. You will be able to verify the properties of the parent in the Konsist test. This API is not finalized yet, but we are aiming to expose parents property containing a list of Konsist declarations:

 Konsist
    .scopeFromProject()
    .classes()
    .assertTrue { it.parents.any { parent -> parent.hasAnnotationOf<Repository> }

We also want to take a look at architecture assertions. Exact changes are quite a vague ATM, but we have a few community-driven threads to process and rethink our approach. We will consider adding “optional/empty layers” and add a few other tweaks to the Konsist API.

Thank you for your engagement using Konsist 🙏 (if you got here you must be really engaged Konsist community member congratulations 🥳). If you are missing something let us know.

Complete list of changes:

⚠️ Breaking API Changes
🐛 Bug Fixes
💡 Improvements
📕 Documentation
🏗️ CI
📦 Dependency Upgrade

Full Changelog: LemonAppDev/konsist@v0.12.2...v0.13.0

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@swapnil-musale swapnil-musale merged commit 5f425c7 into development Oct 9, 2023
2 checks passed
@swapnil-musale swapnil-musale deleted the renovate/konsist branch October 9, 2023 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@swapnil-musale