Converting Stryker4S into Stryker4JVM supporting Scala and Kotlin #1291

mmulder135 · 2023-02-03T22:31:32Z

Stryker4S provides mutation testing for Scala, while Stryker4K does this for Kotlin. Since these projects are developed in parallel, and they are both JVM languages, they have large parts of code with exactly the same functionality (such as file IO, logging and reporting). The main problem to be solved is thus the code duplication between the different code bases. In addition to this, we should try to ensure that the shared interface can also be implemented by other JVM languages at a later time.

Updated dependencies between the files

Updated some imports and dependencies Added IOReporter and wrapper for default core reporters

Fixed many bad references to code from scala-mutator Fixed config encoding/decoding for correct stryker4jvm class (implicits hell makes it really hard to determine where the issue is coming from) Converted the reporters extending from Java 'Reporter' to extending 'IOReporter', there now exists a wrapper to convert pure java reporters to IOReporters Fixed numerous import issues and type issues

Created java classes for some of the scala mutationtesting.elements classes Converted stryker4jvm and stryker4jvm-mutator-scala to use new java core classes Added many converters between core and mutationtesting.elements scala types in Stryker4jvmCoreConversions. Functions declared 'asCoreElement' and 'asMutationElement'. Fixed an issue in splitIgnoredAndFound which was returning an empty stream when size of found was non-zero. Removed intransitive() dependency keyword from build.sbt sbt stryker4jvm/compile compiles with no errors

…ble to compile Stryker4jvm's tests cannot compile, but they never had Commented 'createFinishedRunEvent' in TestData.scala of mutator-scala as FinishedRunEvent is removed from core

* Added a separate location for supported language, implementing the kotlin mutator * obligatory extra scalafmt commit * Optimize imports to remove warning Co-authored-by: Michael Mulder <[email protected]>

# Conflicts: # .github/workflows/ci.yml # core/src/main/scala/stryker4s/Stryker4s.scala # core/src/main/scala/stryker4s/extension/exception/stryker4sException.scala # core/src/main/scala/stryker4s/mutants/findmutants/MutantMatcher.scala # core/src/main/scala/stryker4s/mutants/tree/MutantInstrumenter.scala # core/src/main/scala/stryker4s/run/MutantRunner.scala # core/src/main/scala/stryker4s/run/RollbackHandler.scala # core/src/test/scala/stryker4s/extension/exception/Stryker4sExceptionTest.scala # core/src/test/scala/stryker4s/mutants/AddAllMutationsTest.scala # core/src/test/scala/stryker4s/mutants/RollbackTest.scala # core/src/test/scala/stryker4s/mutants/findmutants/MutantMatcherTest.scala # core/src/test/scala/stryker4s/mutants/tree/MutantInstrumenterTest.scala # core/src/test/scala/stryker4s/report/mapper/MutantRunResultMapperTest.scala # core/src/test/scala/stryker4s/run/MutantRunnerTest.scala # core/src/test/scala/stryker4s/testutil/stubs/TestRunnerStub.scala # stryker4jvm-mutator-scala/src/main/scala/stryker4jvm/mutator/scala/mutants/findmutants/MutantMatcher.scala

…cala)

Sync stryker4s

Removed redundant scala files

Scala dialect

Converted kotlin sample to 1.4.20

Formatting

QA updates

…en as per naming convention (#54)

Add java 11

* Remove core from stryker4s * Update docs * Rename scripted test to jvm * Replacing stryker4s for stryker4jvm * Remove unused commands, correct test * scalafmt * remove cache for maven plugin

hugo-vrijswijk

Some remarks about the overall layout and some remarks from an initial glance. I haven't really looked into the code yet, I'll probably be able to do that in the coming days.

I've also put out a poll to get some community feedback on the naming:

hugo-vrijswijk · 2023-02-04T15:07:14Z

.github/pull_request_template.md

@@ -1,19 +1,7 @@
-<!---


Why was this removed?

No idea, will be restored

hugo-vrijswijk · 2023-02-04T15:08:51Z

.github/workflows/ci.yml

    strategy:
      fail-fast: false
      matrix:
-        java-version: [11, 17]
-        os: ['ubuntu-latest', 'windows-latest']
+        java-version: [ 11, 15 ]


Stryker4s supports the current LTS version of Java, so we should keep testing on it. 15 is EOL so we don't have to test on it

hugo-vrijswijk · 2023-02-04T15:11:02Z

.github/workflows/ci.yml

-        run: sbt 'compile; ++2.13 test'
+      - name: Build core with Maven
+        working-directory: ./stryker4jvm-core
+        run: mvn clean install


Suggested change

run: mvn clean install

run: mvn install

~~You _rarely need to do a clean install for maven. See here why. Adding -B tells maven you're running in 'batch' mode (for cleaner CI output)~~

Looks like it is needed here, but you don't need the clean

When reinstalling locally it is necessary to clean sometimes which is probably why it also exists in the CI but indeed should not have to clean here.

hugo-vrijswijk · 2023-02-04T15:11:38Z

.github/workflows/ci.yml

-          # Sbt version that is tested (1.1.1) doesn't work on Java 17
-          java-version: 11
+          distribution: 'corretto'
+          java-version: 15


Same here for the Java version. Ideally I'd like to see as little changes as possible on the CI script or integration tests in this PR

hugo-vrijswijk · 2023-02-04T15:17:27Z

README.md


 ```scala
-addSbtPlugin("io.stryker-mutator" % "sbt-stryker4s" % stryker4sVersion)
+addSbtPlugin("io.stryker-mutator" % "stryker4jvm-plugin-sbt" % stryker4jvmVersion)


The standard for sbt plugins is to follow sbt-$name, so in this case it would be sbt-stryker4jvm.

It might also be useful to still publish the old artifact (possibly with a scala-steward migration

hugo-vrijswijk · 2023-02-04T16:14:27Z

stryker4jvm-core/merge-notes-java-conversion.txt

+FileResolver has been ignored as it relies on fs2, this may instead be added to stryker4jvm
+
+Reporting:
+Converted scala Reporter to abstract java class without any IO (wrappers may be necessary in stryker4jvm if we wish to work with IO there);


Could the reporters not also be inside stryker4jvm? They shouldn't be used by individual language mutators

The merge-notes are outdated and are merely used during development of stryker4jvm to clarify where some things have been moved. They should not have ended up in the PR and will be removed.

hugo-vrijswijk · 2023-02-04T16:26:18Z

sbt/src/main/scala/stryker4s/log/SbtLogger.scala

-
-class SbtLogger(sbtLogger: SbtInternalLogger) extends Logger {
-
-  def log(level: Level, msg: => String): Unit = sbtLogger.log(toSbtLevel(level), msg)


I don't see this class moved anywhere. How does logging now work inside the plugins?

SbtLogger is moved to module stryker4jvm-plugin-sbt. The SbtLogger class is private but a new FansiSbtLogger class has been created.

hugo-vrijswijk · 2023-02-04T16:28:29Z

project/plugins.sbt

+libraryDependencies += "com.thesamet.scalapb" %% "compilerplugin" % "0.11.11"
+
+// Coverage
+addSbtPlugin("org.scoverage" % "sbt-scoverage" % "2.0.6")


I don't think adding code coverage should really be a goal of this PR. It should probably be separate (or better, use mutation coverage)

I think it exists because of the test coverage QA we set during the project, up to you if you want to keep it in

hugo-vrijswijk · 2023-02-04T16:36:31Z

stryker4jvm/src/main/scala/stryker4jvm/logging/FansiLogger.scala

+import fansi.Str
+import stryker4jvm.core.logging.{LogLevel, Logger}
+
+class FansiLogger(val coreLogger: Logger) {


Maybe a clean solution for the loggers could be to have the same Logger class in core with just Strings in core, but to have this class (maybe renamed to ColorLogger) extend the base Logger and add the Fansi methods and color checking logic. Then the language mutators could have a Logger interface passed, while all the projects 'below' that would get a ColorLogger injected, which would be the same logger instantation, but just with a 'wider' interface

Because fansi.str automatically converts to strings it was unclear at times whether someone was actually using a 'FansiLogger' or a 'core Logger', for this reason it was decided to split it but the proposed solution should work as well.

hugo-vrijswijk · 2023-02-04T16:37:10Z

docs/contributing.md

-This is the contribution guide for Stryker4s. Great to have you here! Here are a few ways you can help to make this project better.
-
+## Developing on stryker4jvm:
+Currently, stryker4jvm is using 3 build tools for all its modules. Stryker4jvm-core is managed by maven,


I think it would also help to have a picture (or ascii diagram) of the project layout as it's quite a bit more complex now

I agree, will add one

…tdated

Coverage plugin still available

Some todos have been added and some text that was removed has been restored.

Added todo for verifying release process Removed unused settings

Directory has not been renamed

Added note for version limitations.

…r4s_pr_update # Conflicts: # docs/contributing.md

Stryker4s pr update

s2176416 and others added 30 commits December 13, 2022 23:42

moved mutator-scala sources to an appropriate package

b4521fa

Moved tests as well

afacc5b

Updated dependencies between the files

Updated test dependencies

bfeccd9

convert stryker4jvm to use java core

3a91d32

WIP refactoring

a35787b

formatting

bc7618d

WIP refactoring

fe6df48

Formatting

f0e603e

WIP refactoring

c757c24

Formatting

0d4ee45

add config to stryker4jvm

d512c8a

merged with michael's refactoring of stryker4jvm to java core

d4733b8

Updated some imports and dependencies Added IOReporter and wrapper for default core reporters

Initial push for removing scala libraries from maven

45eb952

Stryker4jvm-mutator-scala tests are now properly modified to not be a…

5882510

…ble to compile Stryker4jvm's tests cannot compile, but they never had Commented 'createFinishedRunEvent' in TestData.scala of mutator-scala as FinishedRunEvent is removed from core

Scalafmt formatting...

e7ff812

Add supported languages to Mutator creation (#16)

23c944c

* Added a separate location for supported language, implementing the kotlin mutator * obligatory extra scalafmt commit * Optimize imports to remove warning Co-authored-by: Michael Mulder <[email protected]>

Made original stryker4s-core identical to current master

3beec49

Updated Stryker4jvm files not merged already (not including mutator-s…

cfa94d8

…cala)

scalafmt

a6ee4f9

Merge pull request #18 from ISEP-Stryker/sync-stryker4s

44b1a24

Sync stryker4s

Added log-test for stryker4jvm-core

5a3cdf3

Removed redundant scala files

WIP tests config, Stryker4JVM.scala in stryker4jvm-module

325dd1e

Propegate changes from stryker4s tests

644445a

Add tests stryker4jvm.extensions from stryker4s

f4231ef

Add tests stryker4jvm.exception from stryker4s

3878546

Add tests stryker4jvm.files from stryker4s

7d25974

Add tests stryker4jvm.model.Mutator from stryker4s

b4a8c16

Koen-Reefman and others added 13 commits January 29, 2023 10:46

Merge branch 'master' into scala-dialect

ada8bb9

Merge pull request #50 from ISEP-Stryker/scala-dialect

0bb2b14

Scala dialect

Merge pull request #51 from ISEP-Stryker/kotlin-sample-issues

0725ba8

Converted kotlin sample to 1.4.20

Merge pull request #52 from ISEP-Stryker/formatting

5697903

Formatting

Set standard scalaversion, add stryker on mutator-scala to pipeline

9f27cd6

Get coverage in CI, fail build on low coverage

2faa66f

Remove compilation job in CI

5bc6f67

Merge pull request #53 from ISEP-Stryker/qa

10d6db9

QA updates

Maven plugin's artifact id has been renamed to stryker4jvm-plugin-mav…

240b05e

…en as per naming convention (#54)

Add java 11

47af2c8

Merge pull request #56 from ISEP-Stryker/add-java-version

df603fa

Add java 11

Set stryker4s.conf in mutation-testng jobs (#57)

9c9f533

Clean up (#55)

d7afe0a

* Remove core from stryker4s * Update docs * Rename scripted test to jvm * Replacing stryker4s for stryker4jvm * Remove unused commands, correct test * scalafmt * remove cache for maven plugin

hugo-vrijswijk reviewed Feb 4, 2023

View reviewed changes

s2176416 added 13 commits February 10, 2023 15:54

Restore pull request template to what it was

d99d1a1

Update CI to only work with java 11 and 17

f9f9691

Removed development merge-notes, most of the information there was ou…

43b26d7

…tdated

Scala compiler plugin dependency back to 0.11.13

6e59ca9

Coverage plugin still available

Updated docs and readme; added dependency diagram

68c91bc

Some todos have been added and some text that was removed has been restored.

Release and settings update

3291a71

Added todo for verifying release process Removed unused settings

Renamed stryker4jvm-plugin-maven to stryker4jvm-maven-plugin

f248e3f

Renamed module stryker4jvm-plugin-sbt to sbt-stryker4jvm

439daa4

Directory has not been renamed

Restored full-cross versions for api and testrunner

c4858cc

Updated contributing readme

4ad9fcc

Added note for version limitations.

Made dependency diagram relative link

9d8d280

Made dependency diagram link absolute

3ef17ec

Merge remote-tracking branch 'origin/stryker4s_pr_update' into stryke…

ed1d842

…r4s_pr_update # Conflicts: # docs/contributing.md

s2176416 mentioned this pull request Feb 10, 2023

Stryker4s pr update ISEP-Stryker/stryker4jvm#58

Merged

Merge pull request #58 from ISEP-Stryker/stryker4s_pr_update

41de4b8

Stryker4s pr update

YVbakker mentioned this pull request Mar 15, 2024

Converting Stryker4S into Stryker4JVM supporting Scala and Kotlin #1522

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Converting Stryker4S into Stryker4JVM supporting Scala and Kotlin #1291

Converting Stryker4S into Stryker4JVM supporting Scala and Kotlin #1291

mmulder135 commented Feb 3, 2023

hugo-vrijswijk left a comment •

edited

Loading

hugo-vrijswijk Feb 4, 2023

s2176416 Feb 10, 2023

hugo-vrijswijk Feb 4, 2023

hugo-vrijswijk Feb 4, 2023

s2176416 Feb 10, 2023

hugo-vrijswijk Feb 4, 2023

hugo-vrijswijk Feb 4, 2023

hugo-vrijswijk Feb 4, 2023

s2176416 Feb 10, 2023

hugo-vrijswijk Feb 4, 2023

s2176416 Feb 10, 2023

hugo-vrijswijk Feb 4, 2023

s2176416 Feb 10, 2023

hugo-vrijswijk Feb 4, 2023

s2176416 Feb 10, 2023

hugo-vrijswijk Feb 4, 2023

s2176416 Feb 10, 2023


		class SbtLogger(sbtLogger: SbtInternalLogger) extends Logger {

		def log(level: Level, msg: => String): Unit = sbtLogger.log(toSbtLevel(level), msg)

Converting Stryker4S into Stryker4JVM supporting Scala and Kotlin #1291

Are you sure you want to change the base?

Converting Stryker4S into Stryker4JVM supporting Scala and Kotlin #1291

Conversation

mmulder135 commented Feb 3, 2023

hugo-vrijswijk left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hugo-vrijswijk left a comment •

edited

Loading