Move pom operator into codemodder-java repo

.github/workflows/checks.yml

@@ -22,6 +22,14 @@ jobs:
         with:
           distribution: 'temurin'
           java-version: '17'
+          cache: maven
+          server-id: pixee
+          server-username: ${{ vars.PIXEE_ARTIFACTORY_USERNAME }}
+          server-password: ${{ secrets.PIXEE_ARTIFACTORY_PASSWORD }}
+      - name: Set up Maven
+        uses: stCarolas/[email protected]
+        with:
+          maven-version: 3.8.2
       - uses: gradle/gradle-build-action@v2
         with:
           arguments: check --stacktrace

gradle/build-plugins/build.gradle.kts

@@ -24,4 +24,5 @@ dependencies {
     implementation(buildlibs.spotless)
     implementation(buildlibs.nebula.publish.plugin)
     implementation(buildlibs.nebula.contacts.plugin)
+    implementation(buildlibs.kotlin)
 }

gradle/build-plugins/src/main/kotlin/io.codemodder.kotlin.gradle.kts

@@ -0,0 +1,20 @@
+plugins {
+    id("io.codemodder.spotless")
+    id("org.jetbrains.kotlin.jvm")
+}
+
+java {
+    toolchain {
+        languageVersion.set(JavaLanguageVersion.of(17))
+    }
+}
+
+spotless {
+    java {
+        googleJavaFormat()
+    }
+}
+
+tasks.withType(Test::class) {
+    useJUnitPlatform()
+}

gradle/buildlibs.versions.toml

@@ -9,6 +9,7 @@ nebula-contacts-plugin = { module = "com.netflix.nebula.contacts:com.netflix.neb
 nebula-mavenscm-plugin = { module = "com.netflix.nebula.maven-scm:com.netflix.nebula.maven-scm.gradle.plugin", version = "20.3.0"}
 nebula-publish-plugin = { module = "com.netflix.nebula.maven-publish:com.netflix.nebula.maven-publish.gradle.plugin", version = "20.3.0"}
 spotless = { module = "com.diffplug.spotless:spotless-plugin-gradle", version.ref = "spotless" }
+kotlin = { module = "org.jetbrains.kotlin.jvm:org.jetbrains.kotlin.jvm.gradle.plugin", version = "1.8.20"}
 
 [plugins]
 fileversioning = { id = "de.epitschke.gradle-file-versioning", version.ref = "fileversioning" }

pom-operator/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+# Description
+
+# Checklist:
+
+- [ ] I did my own review
+- [ ] Commented Code - particularly in hard sections
+- [ ] Docs (Javadocs)
+- [ ] No TODOs / Issues on Code
+- [ ] Tests: Unit Testing
+- [ ] Tests: Assertions Look Good and Sane
+- [ ] Tests: Coverage
+- [ ] Integration Testing
+- [ ] Java Test Fixtures
+- [ ] Security Risks Considered and Addressed / Mitigated
+

pom-operator/.github/workflows/push-test.yml

@@ -0,0 +1,81 @@
+name: Java CI
+
+on:
+  push:
+    branches-ignore:
+      - 'master'
+
+env:
+  MAVEN_OPTS: "-Dhttps.protocols=TLSv1.2"
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.platform }}
+    environment:
+      name: default
+    env:
+      ARTIFACTORY_USERNAME_REF: "${{ secrets.ARTIFACTORY_USERNAME_REF }}"
+      ARTIFACTORY_TOKEN_REF: "${{ secrets.ARTIFACTORY_TOKEN_REF }}"
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: '8'
+          distribution: 'temurin'
+          cache: maven
+          server-id: pixee
+          server-username: ARTIFACTORY_USERNAME_REF
+          server-password: ARTIFACTORY_TOKEN_REF
+      - name: Set up Maven
+        uses: stCarolas/[email protected]
+        with:
+          maven-version: 3.8.2
+      - name: Resolve all Dependencies
+        run: |
+          mvn -N -B dependency:go-offline
+      - name: Build with Maven
+        run: |
+          mvn -N -B install
+      - name: Integration Testing (Linux Only)
+        if: matrix.platform == 'ubuntu-latest'
+        run: |
+          mvn -N -B -Dmaven.test.skip install
+          mvn -N -B -P integration-testing verify
+      - name: Generate Coverage Badge
+        id: jacoco
+        uses: cicirello/jacoco-badge-generator@v2
+        if: ${{ matrix.platform == 'ubuntu-latest' }}
+        with:
+          generate-branches-badge: true
+      - name: Log coverage percentage
+        if: ${{ matrix.platform == 'ubuntu-latest' }}
+        run: |
+          echo "coverage = ${{ steps.jacoco.outputs.coverage }}"
+          echo "branch coverage = ${{ steps.jacoco.outputs.branches }}"
+      - # When using "Act", disable certain actions, starting with this one
+        # See https://github.com/nektos/act#skipping-steps for more details
+        name: Commit the JaCoCo badge (if it changed)
+        if: ${{ matrix.platform == 'ubuntu-latest' && !env.ACT }}
+        run: |
+          if [[ `git status --porcelain` ]]; then
+          git config --global user.name 'Jacoco Coverage Update Action'
+          git config --global user.email '[email protected]'
+          git add -A
+          git commit -m "[no ci] Autogenerated JaCoCo coverage badge"
+          git push
+          fi
+      - name: Upload JaCoCo coverage report
+        if: ${{ matrix.platform == 'ubuntu-latest' && !env.ACT }}
+        uses: actions/upload-artifact@v2
+        with:
+          name: jacoco-report
+          path: target/site/jacoco/
+
+      - name: Deploy (only if on master)
+        if: ${{ github.ref_name == 'master' && matrix.platform == 'ubuntu-latest' && !env.ACT }}
+        run: |
+          mvn -N -B deploy -DaltDeploymentRepository=pixee::default::https://pixee.jfrog.io/artifactory/mailman-libs-snapshot

pom-operator/.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: Create Release on Semantic Version Tag
+
+on:
+  push:
+    tags:
+      - "v*"
+
+env:
+  M2_HOME: /opt/hostedtoolcache/maven/3.8.2
+  JAVA_HOME: /opt/hostedtoolcache/Java_Adopt_jdk/11.0.17-8
+
+jobs:
+  release:
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - id: setup-java
+        name: "Build, test and deploy"
+        uses: actions/setup-java@v2
+        with:
+          java-version: '11'
+          distribution: 'adopt'
+          server-id: ossrh
+          server-username: MAVEN_USERNAME
+          server-password: MAVEN_PASSWORD
+          gpg-private-key: ${{ secrets.OSSRH_GPG_SECRET_KEY }}
+          gpg-passphrase: MAVEN_GPG_PASSPHRASE
+
+      - name: Set up Maven
+        uses: stCarolas/[email protected]
+        with:
+          maven-version: 3.8.2
+
+      - name: "Publish to Maven Central"
+        run: |
+          mvn -N -B \
+            -Prelease \
+            -X \
+            --no-transfer-progress \
+            --batch-mode \
+            clean \
+            deploy
+        env:
+          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.OSSRH_GPG_SECRET_KEY_PASSPHRASE }}

pom-operator/.gitignore

@@ -0,0 +1,69 @@
+### Maven template
+.cache/
+
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+# https://github.com/takari/maven-wrapper#usage-without-binary-jar
+.mvn/wrapper/maven-wrapper.jar
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+.secrets

pom-operator/README.md

@@ -0,0 +1,68 @@
+[![Actions Status](https://github.com/pixee/pom-operator/workflows/Java%20CI/badge.svg)](https://github.com/pixee/pom-operator/actions)
+![Coverage](.github/badges/jacoco.svg)
+
+# pom-operator
+
+POM Operator is a library responsible for injecting dependencies into POM files programatically.
+
+## Building
+
+Use [Maven](https://maven.apache.org):
+
+```
+$ git clone [email protected]:pixee/pom-operator.git && cd pom-operator
+$ mvn clean install
+```
+
+## Using
+
+There's a sample of usage from Java on the `java-sample` directory - of look under the `src/test` directory as well. TL;DR:
+
+```java
+import org.junit.Test;
+
+import io.github.pixee.maven.operator.ProjectModel;
+import io.github.pixee.maven.operator.Dependency;
+import io.github.pixee.maven.operator.POMOperator;
+import io.github.pixee.maven.operator.ProjectModelFactory;
+
+public class POMOperatorJavaTest {
+  @Test
+  public void testInterop() {
+    ProjectModel projectModel = ProjectModelFactory
+        .load(POMOperatorJavaTest.class.getResource("pom.xml"))
+        .withDependency(
+            new Dependency("org.dom4j", "dom4j", "0.0.0", null, "jar")
+        );
+
+    POMOperator.modify(projectModel);
+  }
+}
+
+```
+
+## How it works?
+
+It implements a Chain of Responsibility strategy - each `Command` class attempts a different way of fixing a POM, based around a Context (in this case, a `ProjectModel`)
+
+## Releasing
+
+e.g. to generate version `0.0.2`:
+
+```
+(mvn versions:set -DnewVersion=0.0.3 && git commit -am "Generating Tag" && git tag v0.0.3 && git push && git push --tags)
+(export V='0.0.11-SNAPSHOT' ; mvn versions:set -DnewVersion=${V} && (cd java-sample ; mvn versions:set -DnewVersion=${V} && git commit -am "Generating development version" && git push))
+```
+
+# TODO:
+
+Deploying:
+
+```
+mvn -N -B deploy  -DaltDeploymentRepository=pixee-libs-release::default::https://pixee.jfrog.io/artifactory/default-maven-local
+```
+
+- ~~better readme~~
+- ~~be able to guess existing indenting for existing documents~~
+- ~~investigate leverage whats on [versions-maven-plugin](https://github.com/mojohaus/versions-maven-plugin)~~
+- consider fuzzying when testing

pom-operator/build.gradle.kts

@@ -0,0 +1,43 @@
+plugins {
+    id("io.codemodder.kotlin")
+}
+
+dependencies {
+    api("com.offbytwo:docopt:0.6.0.20150202")
+    api("org.apache.commons:commons-lang3:3.12.0")
+    api("org.dom4j:dom4j:2.1.3")
+    api("jaxen:jaxen:1.2.0")
+    api("xerces:xercesImpl:2.12.2")
+    api("org.xmlunit:xmlunit-core:2.9.0")
+    api("org.xmlunit:xmlunit-assertj3:2.9.0")
+    api("org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.7.10")
+    api("com.github.zafarkhaja:java-semver:0.9.0")
+    api("commons-io:commons-io:2.11.0")
+    api("org.apache.maven.shared:maven-invoker:3.2.0")
+    api("com.google.inject:guice:5.1.0")
+    api("org.apache.maven:maven-embedder:3.8.6") {
+        exclude(group = "com.google.inject", module = "guice")
+    }
+    api("org.apache.maven:maven-compat:3.8.6") {
+        exclude(group = "com.google.inject", module = "guice")
+    }
+    api("org.apache.maven.resolver:maven-resolver-api:1.9.2")
+    api("org.apache.maven.resolver:maven-resolver-spi:1.9.2")
+    api("org.apache.maven.resolver:maven-resolver-util:1.9.2")
+    api("org.apache.maven.resolver:maven-resolver-impl:1.9.2")
+    api("org.apache.maven.resolver:maven-resolver-transport-file:1.9.2")
+    api("org.apache.maven.resolver:maven-resolver-transport-http:1.9.2")
+    api("org.apache.maven.resolver:maven-resolver-connector-basic:1.9.2")
+    api("org.apache.maven:maven-resolver-provider:3.8.6")
+    api("org.apache.maven:maven-model-builder:3.8.6")
+    api("com.github.albfernandez:juniversalchardet:2.4.0")
+    testImplementation("org.slf4j:slf4j-simple:2.0.0")
+    testImplementation("fun.mike:diff-match-patch:0.0.2")
+    testImplementation("io.github.java-diff-utils:java-diff-utils:4.12")
+    testImplementation("org.hamcrest:hamcrest-all:1.3")
+    testImplementation(testlibs.bundles.junit.jupiter)
+    compileOnly("org.slf4j:slf4j-api:2.0.0")
+    testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")
+    testImplementation("org.junit.jupiter:junit-jupiter-engine:5.9.2")
+    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
+}