From d06d5663df2d6647ad6e623aa434986519dbb57d Mon Sep 17 00:00:00 2001 From: Nikita Stroganov Date: Fri, 1 Jul 2022 12:40:54 +0300 Subject: [PATCH] Rename mock strategy options in gradle and maven plugins (#366) --- .../framework/plugin/sarif/SarifExtensionProvider.kt | 8 ++++---- utbot-gradle/docs/utbot-gradle.md | 10 +++++----- .../gradle/plugin/extension/SarifGradleExtension.kt | 4 ++-- .../extension/SarifGradleExtensionProviderTest.kt | 6 +++--- utbot-maven/docs/utbot-maven.md | 8 ++++---- .../maven/plugin/GenerateTestsAndSarifReportMojo.kt | 4 ++-- utbot-maven/src/test/resources/project-to-test/pom.xml | 2 +- 7 files changed, 21 insertions(+), 21 deletions(-) diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/plugin/sarif/SarifExtensionProvider.kt b/utbot-framework/src/main/kotlin/org/utbot/framework/plugin/sarif/SarifExtensionProvider.kt index db25a95f5c..46e65a514a 100644 --- a/utbot-framework/src/main/kotlin/org/utbot/framework/plugin/sarif/SarifExtensionProvider.kt +++ b/utbot-framework/src/main/kotlin/org/utbot/framework/plugin/sarif/SarifExtensionProvider.kt @@ -93,10 +93,10 @@ interface SarifExtensionProvider { fun mockStrategyParse(mockStrategy: String): MockStrategyApi = when (mockStrategy.toLowerCase()) { - "do-not-mock" -> MockStrategyApi.NO_MOCKS - "package-based" -> MockStrategyApi.OTHER_PACKAGES - "all-except-cut" -> MockStrategyApi.OTHER_CLASSES - else -> error("Parameter mockStrategy == '$mockStrategy', but it can take only 'do-not-mock', 'package-based' or 'all-except-cut'") + "no-mocks" -> MockStrategyApi.NO_MOCKS + "other-packages" -> MockStrategyApi.OTHER_PACKAGES + "other-classes" -> MockStrategyApi.OTHER_CLASSES + else -> error("Parameter mockStrategy == '$mockStrategy', but it can take only 'no-mocks', 'other-packages' or 'other-classes'") } fun staticsMockingParse(staticsMocking: String): StaticsMocking = diff --git a/utbot-gradle/docs/utbot-gradle.md b/utbot-gradle/docs/utbot-gradle.md index 1d699d8a9d..819bb6f71a 100644 --- a/utbot-gradle/docs/utbot-gradle.md +++ b/utbot-gradle/docs/utbot-gradle.md @@ -44,7 +44,7 @@ __Groovy:__ mockFramework = 'mockito' generationTimeout = 60000L codegenLanguage = 'java' - mockStrategy = 'package-based' + mockStrategy = 'other-packages' staticsMocking = 'mock-statics' forceStaticMocking = 'force' classesToMockAlways = ['org.slf4j.Logger', 'java.util.Random'] @@ -62,7 +62,7 @@ __Kotlin DSL:__ mockFramework.set("mockito") generationTimeout.set(60000L) codegenLanguage.set("java") - mockStrategy.set("package-based") + mockStrategy.set("other-packages") staticsMocking.set("mock-statics") forceStaticMocking.set("force") classesToMockAlways.set(listOf("org.slf4j.Logger", "java.util.Random")) @@ -118,9 +118,9 @@ __Kotlin DSL:__ - `mockStrategy` – - The mock strategy to be used. - Can be one of: - - `'do-not-mock'` – do not use mock frameworks at all - - `'package-based'` – mock all classes outside the current package except system ones _(by default)_ - - `'all-except-cut'` – mock all classes outside the class under test except system ones + - `'no-mocks'` – do not use mock frameworks at all + - `'other-packages'` – mock all classes outside the current package except system ones _(by default)_ + - `'other-classes'` – mock all classes outside the class under test except system ones - `staticsMocking` – - Use static methods mocking or not. diff --git a/utbot-gradle/src/main/kotlin/org/utbot/gradle/plugin/extension/SarifGradleExtension.kt b/utbot-gradle/src/main/kotlin/org/utbot/gradle/plugin/extension/SarifGradleExtension.kt index 7a14de1d43..1ebbc1dfda 100644 --- a/utbot-gradle/src/main/kotlin/org/utbot/gradle/plugin/extension/SarifGradleExtension.kt +++ b/utbot-gradle/src/main/kotlin/org/utbot/gradle/plugin/extension/SarifGradleExtension.kt @@ -68,7 +68,7 @@ abstract class SarifGradleExtension { abstract val codegenLanguage: Property /** - * Can be one of: 'do-not-mock', 'package-based', 'all-except-cut'. + * Can be one of: 'no-mocks', 'other-packages', 'other-classes'. */ @get:Input abstract val mockStrategy: Property @@ -105,7 +105,7 @@ sarifReport { mockFramework = 'mockito' generationTimeout = 60 * 1000L codegenLanguage = 'java' - mockStrategy = 'do-not-mock' + mockStrategy = 'no-mocks' staticsMocking = 'do-not-mock-statics' forceStaticMocking = 'force' classesToMockAlways = ['org.utbot.api.mock.UtMock'] diff --git a/utbot-gradle/src/test/kotlin/org/utbot/gradle/plugin/extension/SarifGradleExtensionProviderTest.kt b/utbot-gradle/src/test/kotlin/org/utbot/gradle/plugin/extension/SarifGradleExtensionProviderTest.kt index 9597f982fc..0bc54f1c3e 100644 --- a/utbot-gradle/src/test/kotlin/org/utbot/gradle/plugin/extension/SarifGradleExtensionProviderTest.kt +++ b/utbot-gradle/src/test/kotlin/org/utbot/gradle/plugin/extension/SarifGradleExtensionProviderTest.kt @@ -256,19 +256,19 @@ class SarifGradleExtensionProviderTest { @Test fun `should be equal to NO_MOCKS`() { - setMockStrategy("do-not-mock") + setMockStrategy("no-mocks") assertEquals(MockStrategyApi.NO_MOCKS, extensionProvider.mockStrategy) } @Test fun `should be equal to OTHER_PACKAGES`() { - setMockStrategy("package-based") + setMockStrategy("other-packages") assertEquals(MockStrategyApi.OTHER_PACKAGES, extensionProvider.mockStrategy) } @Test fun `should be equal to OTHER_CLASSES`() { - setMockStrategy("all-except-cut") + setMockStrategy("other-classes") assertEquals(MockStrategyApi.OTHER_CLASSES, extensionProvider.mockStrategy) } diff --git a/utbot-maven/docs/utbot-maven.md b/utbot-maven/docs/utbot-maven.md index 29dc162489..d0949de8ca 100644 --- a/utbot-maven/docs/utbot-maven.md +++ b/utbot-maven/docs/utbot-maven.md @@ -44,7 +44,7 @@ For example, the following configuration may be used: mockito 60000L java - package-based + other-packages mock-statics force @@ -104,9 +104,9 @@ For example, the following configuration may be used: - `mockStrategy` – - The mock strategy to be used. - Can be one of: - - `'do-not-mock'` – do not use mock frameworks at all - - `'package-based'` – mock all classes outside the current package except system ones _(by default)_ - - `'all-except-cut'` – mock all classes outside the class under test except system ones + - `'no-mocks'` – do not use mock frameworks at all + - `'other-packages'` – mock all classes outside the current package except system ones _(by default)_ + - `'other-classes'` – mock all classes outside the class under test except system ones - `staticsMocking` – - Use static methods mocking or not. diff --git a/utbot-maven/src/main/kotlin/org/utbot/maven/plugin/GenerateTestsAndSarifReportMojo.kt b/utbot-maven/src/main/kotlin/org/utbot/maven/plugin/GenerateTestsAndSarifReportMojo.kt index 3660af2576..3728b39162 100644 --- a/utbot-maven/src/main/kotlin/org/utbot/maven/plugin/GenerateTestsAndSarifReportMojo.kt +++ b/utbot-maven/src/main/kotlin/org/utbot/maven/plugin/GenerateTestsAndSarifReportMojo.kt @@ -96,9 +96,9 @@ class GenerateTestsAndSarifReportMojo : AbstractMojo() { internal lateinit var codegenLanguage: String /** - * Can be one of: 'do-not-mock', 'package-based', 'all-except-cut'. + * Can be one of: 'no-mocks', 'other-packages', 'other-classes'. */ - @Parameter(defaultValue = "do-not-mock") + @Parameter(defaultValue = "no-mocks") internal lateinit var mockStrategy: String /** diff --git a/utbot-maven/src/test/resources/project-to-test/pom.xml b/utbot-maven/src/test/resources/project-to-test/pom.xml index 2783607f96..e5e3f239b7 100644 --- a/utbot-maven/src/test/resources/project-to-test/pom.xml +++ b/utbot-maven/src/test/resources/project-to-test/pom.xml @@ -34,7 +34,7 @@ mockito 10000 java - package-based + other-packages mock-statics force