-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#62 ✨ initial Baton integration to support automated migration for mo…
…norepo dependencies; with PR feedback
- Loading branch information
1 parent
c565122
commit 4e7a2d1
Showing
15 changed files
with
542 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
habushu-maven-plugin/src/main/java/org/technologybrewery/habushu/MigrateMojo.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| package org.technologybrewery.habushu; | ||
|
|
||
| import org.apache.maven.plugins.annotations.LifecyclePhase; | ||
| import org.apache.maven.plugins.annotations.Mojo; | ||
| import org.apache.maven.plugins.annotations.ResolutionScope; | ||
| import org.technologybrewery.baton.BatonMojo; | ||
|
|
||
| /** | ||
| * Overriding the baton-maven-plugin so we can get access to Habushu's classpath for migration configuration. | ||
| */ | ||
| @Mojo(name = "baton-migrate", defaultPhase = LifecyclePhase.VALIDATE, requiresDependencyResolution = ResolutionScope.COMPILE, threadSafe = true) | ||
| public class MigrateMojo extends BatonMojo { | ||
| } |
147 changes: 147 additions & 0 deletions
147
...n/src/main/java/org/technologybrewery/habushu/migration/CustomMonorepoGroupMigration.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| package org.technologybrewery.habushu.migration; | ||
|
|
||
| import com.electronwill.nightconfig.core.CommentedConfig; | ||
| import com.electronwill.nightconfig.core.Config; | ||
| import com.electronwill.nightconfig.core.file.FileConfig; | ||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import org.technologybrewery.baton.AbstractMigration; | ||
| import org.technologybrewery.baton.BatonException; | ||
| import org.technologybrewery.habushu.HabushuException; | ||
| import org.technologybrewery.habushu.util.TomlReplacementTuple; | ||
| import org.technologybrewery.habushu.util.TomlUtils; | ||
|
|
||
| import java.io.BufferedReader; | ||
| import java.io.File; | ||
| import java.io.FileReader; | ||
| import java.io.IOException; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
|
|
||
| /** | ||
| * Automatically migrates any monorepo dependencies (e.g., foo = {path = "../foo", develop = true}) in the main | ||
| * [tool.poetry.dependencies] group into the [tool.poetry.group.monorepo.dependencies] group instead. As noted in the | ||
| * project's README.md, this prevents these dependencies from causing issues when Poetry projects are exported in | ||
| * development releases. | ||
| */ | ||
| public class CustomMonorepoGroupMigration extends AbstractMigration { | ||
|
|
||
| public static final Logger logger = LoggerFactory.getLogger(CustomMonorepoGroupMigration.class); | ||
|
|
||
| protected Map<String, TomlReplacementTuple> replacements = new HashMap<>(); | ||
|
|
||
| protected boolean hasExistingMonoRepoDependenciesGroup; | ||
|
|
||
| @Override | ||
| protected boolean shouldExecuteOnFile(File file) { | ||
| replacements.clear(); | ||
| hasExistingMonoRepoDependenciesGroup = false; | ||
|
|
||
| boolean shouldExecute = false; | ||
| try (FileConfig tomlFileConfig = FileConfig.of(file)) { | ||
| tomlFileConfig.load(); | ||
|
|
||
| Optional<Config> toolPoetryDependencies = tomlFileConfig.getOptional(TomlUtils.TOOL_POETRY_DEPENDENCIES); | ||
| if (toolPoetryDependencies.isPresent()) { | ||
| Config foundDependencies = toolPoetryDependencies.get(); | ||
| Map<String, Object> dependencyMap = foundDependencies.valueMap(); | ||
|
|
||
| for (Map.Entry<String, Object> dependency : dependencyMap.entrySet()) { | ||
| String packageName = dependency.getKey(); | ||
| Object packageRhs = dependency.getValue(); | ||
| if (TomlUtils.representsLocalDevelopmentVersion(packageRhs)) { | ||
| String packageRshAsString = TomlUtils.convertCommentedConfigToToml((CommentedConfig) packageRhs); | ||
| logger.info("Found local dependency not within monorepo group! ({} = {})", packageName, packageRshAsString); | ||
| TomlReplacementTuple replacementTuple = new TomlReplacementTuple(packageName, packageRshAsString, ""); | ||
| replacements.put(packageName, replacementTuple); | ||
| shouldExecute = true; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| Optional<Config> toolPoetryMonorepoDependencies = tomlFileConfig.getOptional(TomlUtils.TOOL_POETRY_GROUP_MONOREPO_DEPENDENCIES); | ||
| if (toolPoetryMonorepoDependencies.isPresent()) { | ||
| hasExistingMonoRepoDependenciesGroup = true; | ||
| } | ||
| } | ||
|
|
||
| return shouldExecute; | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean performMigration(File pyProjectTomlFile) { | ||
| String fileContent = StringUtils.EMPTY; | ||
| try (BufferedReader reader = new BufferedReader(new FileReader(pyProjectTomlFile))) { | ||
| String line = reader.readLine(); | ||
| boolean injectAfterNextEmptyLine = false; | ||
|
|
||
| while (line != null) { | ||
| boolean addLine = true; | ||
| boolean isEmptyLine = line.isBlank(); | ||
|
|
||
| if (line.contains(StringUtils.SPACE) && line.contains(TomlUtils.EQUALS)) { | ||
| String key = line.substring(0, line.indexOf(StringUtils.SPACE)); | ||
|
|
||
| if (key == null) { | ||
| key = line.substring(0, line.indexOf(TomlUtils.EQUALS)); | ||
| } | ||
|
|
||
| if (key != null) { | ||
| key = key.strip(); | ||
|
|
||
| TomlReplacementTuple matchedTuple = replacements.get(key); | ||
| if (matchedTuple != null) { | ||
| // skip this line, we will add it back to [tool.poetry.group.monorepo.dependencies] later | ||
| addLine = false; | ||
| } | ||
| } | ||
|
|
||
| } else if (line.contains("[") && line.contains("]")) { | ||
| String key = line.strip(); | ||
|
|
||
| if (hasExistingMonoRepoDependenciesGroup && (key.equals("[" + TomlUtils.TOOL_POETRY_GROUP_MONOREPO_DEPENDENCIES + "]"))) { | ||
| // skip this line as we are overriding with the line plus monorepo dependencies here: | ||
| addLine = false; | ||
| fileContent += line + "\n"; | ||
| fileContent = injectMonorepoDependencies(fileContent); | ||
| } else if (!hasExistingMonoRepoDependenciesGroup && (key.equals("[" + TomlUtils.TOOL_POETRY_DEPENDENCIES + "]"))) { | ||
| injectAfterNextEmptyLine = true; | ||
| } | ||
| } | ||
|
|
||
| if (isEmptyLine && injectAfterNextEmptyLine) { | ||
| fileContent += "\n[" + TomlUtils.TOOL_POETRY_GROUP_MONOREPO_DEPENDENCIES + "]" + "\n"; | ||
| fileContent = injectMonorepoDependencies(fileContent); | ||
| injectAfterNextEmptyLine = false; | ||
| } | ||
|
|
||
| if (addLine) { | ||
| fileContent += line + "\n"; | ||
| } | ||
|
|
||
| line = reader.readLine(); | ||
| } | ||
|
|
||
| } catch (IOException e) { | ||
| throw new HabushuException("Problem reading pyproject.toml to update with managed dependencies!", e); | ||
| } | ||
|
|
||
| try { | ||
| TomlUtils.writeTomlFile(pyProjectTomlFile, fileContent); | ||
| } catch (IOException e) { | ||
| throw new BatonException("Problem moving monorepo dependencies to [tool.poetry.group.monorepo.dependencies]!", e); | ||
| } | ||
|
|
||
| return true; | ||
|
|
||
| } | ||
|
|
||
| private String injectMonorepoDependencies(String fileContent) { | ||
| for (Map.Entry<String, TomlReplacementTuple> entry : replacements.entrySet()) { | ||
| fileContent += entry.getKey() + " = " + TomlUtils.escapeTomlRightHandSide(entry.getValue().getOriginalOperatorAndVersion()) + "\n"; | ||
| } | ||
| return fileContent; | ||
| } | ||
| } |
28 changes: 28 additions & 0 deletions
28
...u-maven-plugin/src/main/java/org/technologybrewery/habushu/util/TomlReplacementTuple.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| package org.technologybrewery.habushu.util; | ||
|
|
||
| public class TomlReplacementTuple { | ||
| private String packageName; | ||
|
|
||
| private String originalOperatorAndVersion; | ||
|
|
||
| private String updatedOperatorAndVersion; | ||
|
|
||
| public TomlReplacementTuple(String packageName, String originalOperatorAndVersion, String updatedOperatorAndVersion) { | ||
| this.packageName = packageName; | ||
| this.originalOperatorAndVersion = originalOperatorAndVersion; | ||
| this.updatedOperatorAndVersion = updatedOperatorAndVersion; | ||
|
|
||
| } | ||
|
|
||
| public String getPackageName() { | ||
| return packageName; | ||
| } | ||
|
|
||
| public String getOriginalOperatorAndVersion() { | ||
| return originalOperatorAndVersion; | ||
| } | ||
|
|
||
| public String getUpdatedOperatorAndVersion() { | ||
| return updatedOperatorAndVersion; | ||
| } | ||
| } |
Oops, something went wrong.