Add project dependency mutation #368

asodja · 2021-11-11T15:08:52Z

We generate projects before scenario begins so we don't modify settings.gradle later. And then combinations of project dependencies are applied to the build.

README.md

src/main/java/org/gradle/profiler/mutations/support/FileSupport.java

src/main/java/org/gradle/profiler/mutations/FileChangeMutatorConfigurator.java

src/main/java/org/gradle/profiler/mutations/support/ProjectCombinations.java

src/main/java/org/gradle/profiler/mutations/support/ProjectCombinationsSupport.java

...est/groovy/org/gradle/profiler/mutations/ApplyProjectDependencyChangeSetupMutatorTest.groovy

Co-authored-by: Lóránt Pintér <lorant@gradle.com>

…tor and ApplyProjectDependencyChangeSetupMutator

README.md

src/main/java/org/gradle/profiler/CompositeBuildMutator.java

src/main/java/org/gradle/profiler/mutations/support/FileSupport.java

lptr · 2021-11-30T13:47:40Z

src/main/java/org/gradle/profiler/mutations/support/ProjectCombinationsSupport.java

+import static com.google.common.base.Preconditions.checkArgument;
+import static org.gradle.profiler.mutations.ApplyProjectDependencyChangeMutatorConfigurator.APPLIED_PROJECTS_COUNT_KEY;
+
+public class ProjectCombinationsSupport {


Why not have these methods on ProjectCombinations?

I really like "data only classes". So classes that don't have any logic in there (except maybe trivial creator methods), since that makes other code easier to test. Also having such code in classes then you soon end with multiple similar static methods and class gets bloated and harder to read.

This particular logic is already a bit complex so I decided to move out of it. I left the supported class due to what is written on next comment. Let me know what you think there.

I agree that we shouldn't have instance methods mutating state, but this is something different. This is a static factory method that belongs to ProjectCombinations. I don't see any benefit in moving it out to a separate class.

removed support class

lptr · 2021-11-30T13:48:41Z

src/main/java/org/gradle/profiler/mutations/support/ProjectCombinations.java

+import java.util.List;
+import java.util.Set;
+
+public class ProjectCombinations {


Why does this belong in a package called support? This is part of the mutators.

If we could merge the two project-dependency-change-related mutators, we could move this to a nested subclass, and that'd look a lot better I think.

Mutations package is really huge, and it's hard to find classes there. I created this package so these support classes, that are not mutators, are easy to find. They are still under mutations package.

I will check how easy it is to merge two classes into one.

I merged mutator classes into one. Code wise it is probably easier to understand. I also moved ProjectCombinations as a subclass of now one mutator class.

But I kept the support class, that way since it's a bit complex logic and it's much nicer to test that if it is separate. And since it's easier to test that when separate unit, that is a good flag for me that it might deserve a separate class. WDYT?

I like that ProjectCombinations is now a nested class. I think that makes this support class even more of an orphan that should be reunited with its folks.

removed support class

src/test/groovy/org/gradle/profiler/mutations/ApplyChangeToAndroidLayoutFileMutatorTest.groovy

lptr · 2021-11-30T13:51:15Z

src/test/groovy/org/gradle/profiler/mutations/ApplyChangeToAndroidLayoutFileMutatorTest.groovy

@@ -47,6 +50,7 @@ class ApplyChangeToAndroidLayoutFileMutatorTest extends AbstractMutatorTest {
        def mutator = new ApplyChangeToAndroidLayoutFileMutator(sourceFile)

        when:
+        mutator.beforeScenario(scenarioContext)
        mutator.afterScenario(scenarioContext)


I think these tests don't make much sense now. We could make some random change between beforeScenario() and afterScenario() to make it meaningful.

But since this logic of "saving and restoring the original text" happens for every file change mutator, it's not really useful to test it so many times.

Maybe a better option would be to have a method to create the mutator in every test that also calls mutator.beforeScenario() and mutator.beforeBuild()?

I see your point., but there are actually tests with: reverts changes when nothing has been applied :D. So they already tested before that there is no action.

I left them for now, since they are there, do you think I should delete them to not continue with that pattern in future?

Co-authored-by: Lóránt Pintér <lorant@gradle.com>

lptr

LGTM, the remaining comments are about code style that we can discuss separately if we want.

lptr · 2021-12-06T15:11:14Z

src/test/groovy/org/gradle/profiler/mutations/support/ProjectCombinationsTest.groovy

@@ -1,12 +1,15 @@
 package org.gradle.profiler.mutations.support


Shall we move this to a level higher? Or merge the test into ApplyProjectDependencyChangeMutatorTest?

lptr · 2021-12-06T15:12:37Z

src/main/java/org/gradle/profiler/mutations/ApplyProjectDependencyChangeMutator.java

@@ -123,5 +139,78 @@ public ProjectCombinations(List<String> projectNames, Set<Set<String>> combinati
        public Set<String> getNextCombination() {
            return combinations.next();
        }
+
+        public static ProjectCombinations createProjectCombinations(int numberOfRequiredCombinations, int appliedProjectsCount) {


No need for this to be public (we typically use default visibility + @VisibleForTesing for methods that need to be available from tests). The methods can also be part of ApplyProjectDependencyChangeMutator itself, though that might be a question of taste.

Removed public and add annotation

… also limit scope of ProjectCombinations creator method

asodja added enhancement @execution labels Nov 11, 2021

asodja changed the base branch from master to asodja/android-studio-int-tests November 11, 2021 15:09

asodja self-assigned this Nov 12, 2021

asodja added 6 commits November 12, 2021 09:34

Started on dependency mutation

81d7204

Calculate project combinations for dependency mutation

3e179f8

Move combinations code to a separate class

e9c9206

Add dependency mutator tests

aeecfbe

Refactor dependency mutator

5d3e424

Add dependency mutation in to the README

03eb0e8

asodja force-pushed the asodja/dependency-mutation branch from b66e2a3 to 70b4c2a Compare November 12, 2021 08:34

asodja changed the base branch from asodja/android-studio-int-tests to master November 12, 2021 08:34

lptr reviewed Nov 12, 2021

View reviewed changes

README.md Outdated Show resolved Hide resolved

asodja requested a review from wolfs November 12, 2021 09:14

asodja force-pushed the asodja/dependency-mutation branch from 70b4c2a to b0baab1 Compare November 13, 2021 00:22

Add some extra tests for dependency mutation

44a9289

asodja force-pushed the asodja/dependency-mutation branch 2 times, most recently from 75a69c1 to 5099b4b Compare November 14, 2021 20:11

Rename configuration values for project dependency mutator

a6371b3

asodja force-pushed the asodja/dependency-mutation branch from 5099b4b to a6371b3 Compare November 14, 2021 20:18

Fix project paths for Windows

24eacfd

asodja changed the title ~~Add dependency mutation~~ Add project dependency mutation Nov 15, 2021

asodja removed the request for review from wolfs November 15, 2021 11:08

lptr reviewed Nov 16, 2021

View reviewed changes

asodja and others added 2 commits November 16, 2021 13:59

Apply review comments

c2a5e14

Apply review suggestions

586b0bb

Co-authored-by: Lóránt Pintér <lorant@gradle.com>

asodja force-pushed the asodja/dependency-mutation branch from d6e3c3d to 586b0bb Compare November 16, 2021 13:02

Move reading original text to beforeScenario phase for FileChangeMuta…

7e91164

…tor and ApplyProjectDependencyChangeSetupMutator

asodja force-pushed the asodja/dependency-mutation branch from 6ed99ea to 5ac46f1 Compare November 16, 2021 18:57

asodja commented Nov 16, 2021

View reviewed changes

README.md Outdated Show resolved Hide resolved

Calculate number of generated projects automatically

b104d9a

asodja force-pushed the asodja/dependency-mutation branch from 5ac46f1 to b104d9a Compare November 17, 2021 19:37

asodja requested a review from lptr November 22, 2021 08:19

lptr reviewed Nov 30, 2021

View reviewed changes

asodja and others added 4 commits December 1, 2021 09:56

Merge branch 'master' into asodja/dependency-mutation

c3481d1

Apply review comments to the code

c5854ba

Apply suggestions from code review for documentation

2762a41

Co-authored-by: Lóránt Pintér <lorant@gradle.com>

Change applied-projects-count to dependency-count

11dc2be

asodja force-pushed the asodja/dependency-mutation branch from e331aa7 to 11dc2be Compare December 1, 2021 12:41

asodja requested a review from lptr December 1, 2021 12:42

lptr approved these changes Dec 6, 2021

View reviewed changes

Apply review comments

f2b2672

lptr approved these changes Dec 6, 2021

View reviewed changes

Move ProjectCombinationsTest to org.gradle.profiler.mutations package…

64db5c9

… also limit scope of ProjectCombinations creator method

asodja merged commit bee76c5 into master Dec 6, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add project dependency mutation #368

Add project dependency mutation #368

asodja commented Nov 11, 2021 •

edited

Loading

lptr Nov 30, 2021

asodja Dec 1, 2021 •

edited

Loading

lptr Dec 6, 2021

asodja Dec 6, 2021

lptr Nov 30, 2021

asodja Dec 1, 2021

asodja Dec 1, 2021

lptr Dec 6, 2021

asodja Dec 6, 2021

lptr Nov 30, 2021

lptr Nov 30, 2021

asodja Dec 1, 2021

lptr left a comment

lptr Dec 6, 2021

asodja Dec 6, 2021

lptr Dec 6, 2021

asodja Dec 6, 2021

		@@ -1,12 +1,15 @@
		package org.gradle.profiler.mutations.support

Add project dependency mutation #368

Add project dependency mutation #368

Conversation

asodja commented Nov 11, 2021 • edited Loading

Choose a reason for hiding this comment

asodja Dec 1, 2021 • 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

lptr left a 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

asodja commented Nov 11, 2021 •

edited

Loading

asodja Dec 1, 2021 •

edited

Loading