diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..afd59d8 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,8 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..379e49f --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,29 @@ +--- +name: ci + +on: + push: + branches: + - main + tags-ignore: + - "*" + pull_request: + branches: + - main + workflow_dispatch: {} + schedule: + - cron: 0 17 * * * + +concurrency: + group: ci-${{ github.ref }} + cancel-in-progress: true + +jobs: + build: + uses: openrewrite/gh-automation/.github/workflows/ci-gradle.yml@main + secrets: + gradle_enterprise_access_key: ${{ secrets.GRADLE_ENTERPRISE_ACCESS_KEY }} + ossrh_username: ${{ secrets.OSSRH_USERNAME }} + ossrh_token: ${{ secrets.OSSRH_TOKEN }} + ossrh_signing_key: ${{ secrets.OSSRH_SIGNING_KEY }} + ossrh_signing_password: ${{ secrets.OSSRH_SIGNING_PASSWORD }} diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..960455a --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,22 @@ +--- +name: publish + +on: + push: + tags: + - v[0-9]+.[0-9]+.[0-9]+ + - v[0-9]+.[0-9]+.[0-9]+-rc.[0-9]+ + +concurrency: + group: publish-${{ github.ref }} + cancel-in-progress: false + +jobs: + release: + uses: openrewrite/gh-automation/.github/workflows/publish-gradle.yml@main + secrets: + gradle_enterprise_access_key: ${{ secrets.GRADLE_ENTERPRISE_ACCESS_KEY }} + ossrh_username: ${{ secrets.OSSRH_USERNAME }} + ossrh_token: ${{ secrets.OSSRH_TOKEN }} + ossrh_signing_key: ${{ secrets.OSSRH_SIGNING_KEY }} + ossrh_signing_password: ${{ secrets.OSSRH_SIGNING_PASSWORD }} diff --git a/.github/workflows/receive-pr.yml b/.github/workflows/receive-pr.yml new file mode 100644 index 0000000..f2751ff --- /dev/null +++ b/.github/workflows/receive-pr.yml @@ -0,0 +1,17 @@ +name: receive-pr + +on: + pull_request: + types: [opened, synchronize] + branches: + - main + +concurrency: + group: '${{ github.workflow }} @ ${{ github.ref }}' + cancel-in-progress: true + +# https://securitylab.github.com/research/github-actions-preventing-pwn-requests/ +# Since this pull request receives untrusted code, we should **NOT** have any secrets in the environment. +jobs: + upload-patch: + uses: openrewrite/gh-automation/.github/workflows/receive-pr.yml@main \ No newline at end of file diff --git a/.github/workflows/repository-backup.yml b/.github/workflows/repository-backup.yml new file mode 100644 index 0000000..9627cb5 --- /dev/null +++ b/.github/workflows/repository-backup.yml @@ -0,0 +1,18 @@ +--- +name: repository-backup +on: + workflow_dispatch: {} + schedule: + - cron: 0 17 * * * + +concurrency: + group: backup-${{ github.ref }} + cancel-in-progress: false + +jobs: + repository-backup: + uses: openrewrite/gh-automation/.github/workflows/repository-backup.yml@main + secrets: + bucket_mirror_target: ${{ secrets.S3_GITHUB_REPOSITORY_BACKUPS_BUCKET_NAME }} + bucket_access_key_id: ${{ secrets.S3_GITHUB_REPOSITORY_BACKUPS_ACCESS_KEY_ID }} + bucket_secret_access_key: ${{ secrets.S3_GITHUB_REPOSITORY_BACKUPS_SECRET_ACCESS_KEY }} diff --git a/.gitignore b/.gitignore index 524f096..1b2894e 100644 --- a/.gitignore +++ b/.gitignore @@ -7,11 +7,7 @@ # BlueJ files *.ctxt -# Mobile Tools for Java (J2ME) -.mtj.tmp/ - # Package Files # -*.jar *.war *.nar *.ear @@ -22,3 +18,29 @@ # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml hs_err_pid* replay_pid* + +.gradle +**/build/ +!src/**/build/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# Avoid ignore Gradle wrappper properties +!gradle-wrapper.properties + +# Cache of project +.gradletasknamecache + +# Eclipse Gradle plugin generated files +# Eclipse Core +.project +# JDT-specific (Eclipse Java Development Tools) +.classpath + +.idea/ +out/ +src/main/generated/ diff --git a/README.md b/README.md index 5ab50c6..c42a8a3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ -# rewrite-dotnet -OpenRewrite recipes based on .NET tools +![Logo](https://github.com/openrewrite/rewrite/raw/main/doc/logo-oss.png) +### OpenRewrite recipes based on .NET tools. + +[![ci](https://github.com/openrewrite/rewrite-dotnet/actions/workflows/ci.yml/badge.svg)](https://github.com/openrewrite/rewrite-dotnet/actions/workflows/ci.yml) +[![Apache 2.0](https://img.shields.io/github/license/openrewrite/rewrite-dotnet.svg)](https://www.apache.org/licenses/LICENSE-2.0) +[![Maven Central](https://img.shields.io/maven-central/v/org.openrewrite.recipe/rewrite-dotnet.svg)](https://mvnrepository.com/artifact/org.openrewrite.recipe/rewrite-dotnet) +[![Revved up by Develocity](https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A)](https://ge.openrewrite.org/scans) + +### What is this? + +This project implements a [Rewrite module](https://github.com/openrewrite/rewrite) that migrates projects using .NET tools. + +Browse [a selection of recipes available through this module in the recipe catalog](https://docs.openrewrite.org/recipes/dotnet). + +## Contributing + +We appreciate all types of contributions. See the [contributing guide](https://github.com/openrewrite/.github/blob/main/CONTRIBUTING.md) for detailed instructions on how to get started. diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..56a1071 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,15 @@ +plugins { + id("org.openrewrite.build.recipe-library") version "latest.release" +} + +group = "org.openrewrite.recipe" +description = "OpenRewrite recipes based on .NET tools" + +val rewriteVersion = rewriteRecipe.rewriteVersion.get() +dependencies { + implementation(platform("org.openrewrite:rewrite-bom:$rewriteVersion")) + + implementation("org.openrewrite:rewrite-core") + + testImplementation("org.openrewrite:rewrite-test") +} diff --git a/gradle/licenseHeader.txt b/gradle/licenseHeader.txt new file mode 100644 index 0000000..3c7a454 --- /dev/null +++ b/gradle/licenseHeader.txt @@ -0,0 +1,13 @@ +Copyright ${year} the original author or authors. +

+Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at +

+https://www.apache.org/licenses/LICENSE-2.0 +

+Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100755 index 0000000..d64cd49 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100755 index 0000000..0aaefbc --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..1aa94a4 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100755 index 0000000..93e3f59 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..9ce12d3 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,31 @@ +rootProject.name = "rewrite-dotnet" + +plugins { + id("com.gradle.enterprise") version "latest.release" + id("com.gradle.common-custom-user-data-gradle-plugin") version "1.12.1" +} + +gradleEnterprise { + val isCiServer = System.getenv("CI")?.equals("true") ?: false + server = "https://ge.openrewrite.org/" + + buildCache { + remote(gradleEnterprise.buildCache) { + isEnabled = true + val accessKey = System.getenv("GRADLE_ENTERPRISE_ACCESS_KEY") + isPush = isCiServer && !accessKey.isNullOrBlank() + } + } + + buildScan { + capture { + isTaskInputFiles = true + } + + isUploadInBackground = !isCiServer + + publishAlways() + this as com.gradle.enterprise.gradleplugin.internal.extension.BuildScanExtensionWithHiddenFeatures + publishIfAuthenticated() + } +} diff --git a/src/main/java/org/openrewrite/dotnet/UpgradeAssistant.java b/src/main/java/org/openrewrite/dotnet/UpgradeAssistant.java new file mode 100644 index 0000000..01e9e29 --- /dev/null +++ b/src/main/java/org/openrewrite/dotnet/UpgradeAssistant.java @@ -0,0 +1,110 @@ +/* + * Copyright 2024 the original author or authors. + *

+ * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + *

+ * https://www.apache.org/licenses/LICENSE-2.0 + *

+ * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.openrewrite.dotnet; + +import lombok.EqualsAndHashCode; +import lombok.Value; +import org.openrewrite.ExecutionContext; +import org.openrewrite.Option; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.UncheckedIOException; +import java.nio.file.*; +import java.util.*; +import java.util.stream.Collectors; + +@Value +@EqualsAndHashCode(callSuper = false) +public class UpgradeAssistant extends UpgradeAssistantRecipe { + + @Option( + displayName = "Target framework version", + description = "Target framework to which source project should be upgraded.", + example = "net9.0") + String targetFramework; + + @Override + public String getDisplayName() { + return "Upgrade a .NET project using upgrade-assistant"; + } + + @Override + public String getDescription() { + return "Run [upgrade-assistant upgrade](https://learn.microsoft.com/en-us/dotnet/core/porting/upgrade-assistant-overview) " + + "across a project to upgrade it to a newer .NET framework version."; + } + + @Override + public List buildUpgradeAssistantCommand(Accumulator acc, ExecutionContext ctx, Path projectFile) { + List command = new ArrayList<>(); + command.add(getUpgradeAssistantPath().toString()); + command.add("upgrade"); + command.add(projectFile.toString()); + command.add("--non-interactive"); + command.add("--operation"); + command.add("Inplace"); + command.add("--targetFramework"); + command.add(targetFramework); + return command; + } + + @Override + public void runUpgradeAssistant(Accumulator acc, ExecutionContext ctx) { + for (Path projectFile : acc.getProjectFiles()) { + execUpgradeAssistant(projectFile, acc, ctx); + + } + } + + @Override + protected void processOutput(Path projectFile, Path output, Accumulator acc) { + Path projectDir = projectFile.getParent(); + + try (BufferedReader reader = Files.newBufferedReader(output)) { + String fileName = null; + List transformerLogs = new ArrayList<>(); + + for (String line = reader.readLine(); line != null; line = reader.readLine()) { + if (line.startsWith("Unknown target framework")) { + acc.addFileError(projectFile, line); + break; + } + String[] parts = line.split("\\s+"); + if (parts.length == 0) { + continue; + } + String token = parts[0]; + if (token.startsWith("file.")) { + fileName = parts[1].replace("...", ""); + } else if (fileName != null) { + if ("Succeeded".equals(token) || "Skipped".equals(token) || "Failed".equals(token)) { + if ("Failed".equals(token)) { + String error = transformerLogs.stream().map(String::trim).collect(Collectors.joining("\n")); + acc.addFileError(projectDir.resolve(fileName), error); + } + fileName = null; + transformerLogs.clear(); + } else { + transformerLogs.add(line); + } + } + } + } catch (IOException e) { + throw new UncheckedIOException(e); + } + } +} diff --git a/src/main/java/org/openrewrite/dotnet/UpgradeAssistantAnalysis.java b/src/main/java/org/openrewrite/dotnet/UpgradeAssistantAnalysis.java new file mode 100644 index 0000000..37db23e --- /dev/null +++ b/src/main/java/org/openrewrite/dotnet/UpgradeAssistantAnalysis.java @@ -0,0 +1,65 @@ +/* + * Copyright 2024 the original author or authors. + *

+ * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + *

+ * https://www.apache.org/licenses/LICENSE-2.0 + *

+ * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.openrewrite.dotnet; + +import lombok.Value; +import org.jspecify.annotations.Nullable; +import org.openrewrite.Column; +import org.openrewrite.DataTable; +import org.openrewrite.Recipe; + +import java.net.URL; + +public class UpgradeAssistantAnalysis extends DataTable { + public UpgradeAssistantAnalysis(Recipe recipe) { + super(recipe, + "Upgrade-assistant analysis", + ".NET project upgrade analysis report generated by upgrade-assistant."); + } + + @Value + public static class Row { + @Column(displayName = "Project path", + description = "The path of the analyzed project file.") + String projectPath; + + @Column(displayName = "Source path", + description = "The path of the analyzed source file.") + String sourcePath; + + @Column(displayName = "Issue", + description = "Issue.") + String issue; + + @Column(displayName = "Description", + description = "Description of issue.") + String description; + + @Column(displayName = "Code snippet", + description = "Code snippet raising issue.") + String codeSnippet; + + @Column(displayName = "Recommendation", + description = "Recommendation to address issue.") + @Nullable + String recommendation; + + @Column(displayName = "Link", + description = "Link to further documentation related to updating the source file.") + @Nullable + URL link; + } +} diff --git a/src/main/java/org/openrewrite/dotnet/UpgradeAssistantAnalyze.java b/src/main/java/org/openrewrite/dotnet/UpgradeAssistantAnalyze.java new file mode 100644 index 0000000..23fcd2b --- /dev/null +++ b/src/main/java/org/openrewrite/dotnet/UpgradeAssistantAnalyze.java @@ -0,0 +1,190 @@ +/* + * Copyright 2024 the original author or authors. + *

+ * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + *

+ * https://www.apache.org/licenses/LICENSE-2.0 + *

+ * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.openrewrite.dotnet; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import lombok.EqualsAndHashCode; +import lombok.Value; +import org.jspecify.annotations.Nullable; +import org.openrewrite.ExecutionContext; +import org.openrewrite.Option; +import org.openrewrite.RecipeException; +import org.openrewrite.SourceFile; + +import java.io.IOException; +import java.net.URL; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.*; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +@Value +@EqualsAndHashCode(callSuper = false) +public class UpgradeAssistantAnalyze extends UpgradeAssistantRecipe { + private static final Pattern RECOMMENDATION_SNIPPET_PATTERN = + Pattern.compile("(.*)\\n\\nRecommendation:\\n\\n(.*)"); + private static final Pattern CURRENT_NEW_SNIPPET_PATTERN = + Pattern.compile("Current: (.*)\\nNew: (.*)"); + + transient UpgradeAssistantAnalysis analysisTable = new UpgradeAssistantAnalysis(this); + + @Option( + displayName = "Target framework version", + description = "Target framework to which source project should be upgraded.", + example = "net9.0") + String targetFramework; + + @Option( + displayName = "Privacy mode", + description = "Specifies how much data is included in the generated data table.", + example = "Restricted", + valid = {"Unrestricted", "Protected", "Restricted"}) + @Nullable + String privacyMode; + + @Override + public String getDisplayName() { + return "Analyze a .NET project using upgrade-assistant"; + } + + @Override + public String getDescription() { + return "Run [upgrade-assistant analyze](https://learn.microsoft.com/en-us/dotnet/core/porting/upgrade-assistant-overview) " + + "across a project to analyze changes required to upgrade it to a newer .NET framework version." + + "This recipe will generate a org.openrewrite.dotnet.UpgradeAssistantAnalysis data table containing " + + "the report details."; + } + + @Override + public List buildUpgradeAssistantCommand(Accumulator acc, ExecutionContext ctx, Path solutionFile) { + List command = new ArrayList<>(); + command.add(getUpgradeAssistantPath().toString()); + command.add("analyze"); + command.add(solutionFile.toString()); + command.add("--source"); + command.add("Solution"); + command.add("--code"); + command.add("--privacyMode"); + command.add(Optional.ofNullable(privacyMode).orElse("Protected")); + command.add("--non-interactive"); + command.add("--targetFramework"); + command.add(targetFramework); + command.add("--serializer"); + command.add("JSON"); + command.add("--report"); + command.add(buildReportPath(acc, solutionFile).getFileName().toString()); + return command; + } + + @Override + public void runUpgradeAssistant(Accumulator acc, ExecutionContext ctx) { + for (Path solutionFile : acc.getSolutionFiles()) { + Path reportPath = buildReportPath(acc, solutionFile); + deleteFile(reportPath); + execUpgradeAssistant(solutionFile, acc, ctx); + } + } + + @Override + protected void processOutput(Path solutionFile, Path output, Accumulator acc) { + Path reportPath = buildReportPath(acc, solutionFile); + + try { + ObjectMapper objectMapper = new ObjectMapper(); + JsonNode reportNode = objectMapper.readTree(reportPath.toFile()); + JsonNode rulesNode = reportNode.get("rules"); + Iterator> iterator = rulesNode.fields(); + while (iterator.hasNext()) { + Map.Entry entry = iterator.next(); + acc.addRule(entry.getKey(), entry.getValue()); + } + + for (JsonNode projectNode : reportNode.get("projects")) { + for (JsonNode ruleInstanceNode : projectNode.get("ruleInstances")) { + JsonNode locationNode = ruleInstanceNode.get("location"); + Path filePath = Paths.get(locationNode.get("path").asText()); + acc.addFileResult(acc.getDirectory().resolve(filePath), ruleInstanceNode); + } + } + } catch (IOException e) { + throw new RecipeException(e); + } + } + + private Path buildReportPath(Accumulator acc, Path solutionFile) { + String reportName = solutionFile.getFileName().toString().replace(".sln", "-analyze.json"); + return acc.getDirectory().resolve(reportName); + } + + @Override + protected SourceFile createAfter(SourceFile before, Accumulator acc, ExecutionContext ctx) { + List results = acc.getFileResults(acc.resolvedPath(before)); + if (results != null) { + for (JsonNode ruleInstanceNode : results) { + analysisTable.insertRow(ctx, buildUpgradeAssistantAnalysisRow(ruleInstanceNode, acc)); + } + } + + return super.createAfter(before, acc, ctx); + } + + private UpgradeAssistantAnalysis.Row buildUpgradeAssistantAnalysisRow(JsonNode ruleInstanceNode, Accumulator acc) { + JsonNode locationNode = ruleInstanceNode.get("location"); + URL link = null; + if (locationNode.has("links")) { + try { + JsonNode linkNode = locationNode.get("links").get(0); + link = new URL(linkNode.get("url").asText()); + } catch (IOException ignored) { + // Ignored + } + } + + String projectPath = ruleInstanceNode.get("projectPath").asText(); + String sourcePath = locationNode.get("path").asText(); + String ruleId = ruleInstanceNode.get("ruleId").asText(); + String ruleLabel = acc.getRuleLabel(ruleId); + + String snippet = locationNode.get("snippet").asText(); + String codeSnippet; + String recommendation; + Matcher matcher = RECOMMENDATION_SNIPPET_PATTERN.matcher(snippet); + if (matcher.find()) { + codeSnippet = matcher.group(1); + recommendation = matcher.group(2); + } else { + matcher = CURRENT_NEW_SNIPPET_PATTERN.matcher(snippet); + if (matcher.find()) { + codeSnippet = matcher.group(1); + recommendation = matcher.group(2); + } else { + codeSnippet = snippet; + recommendation = null; + } + } + + return new UpgradeAssistantAnalysis.Row( + projectPath, + sourcePath, + ruleId, + ruleLabel, + codeSnippet, + recommendation, + link); + } +} diff --git a/src/main/java/org/openrewrite/dotnet/UpgradeAssistantRecipe.java b/src/main/java/org/openrewrite/dotnet/UpgradeAssistantRecipe.java new file mode 100644 index 0000000..ddf5e5e --- /dev/null +++ b/src/main/java/org/openrewrite/dotnet/UpgradeAssistantRecipe.java @@ -0,0 +1,367 @@ +/* + * Copyright 2024 the original author or authors. + *

+ * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + *

+ * https://www.apache.org/licenses/LICENSE-2.0 + *

+ * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.openrewrite.dotnet; + +import com.fasterxml.jackson.databind.JsonNode; +import lombok.EqualsAndHashCode; +import lombok.Getter; +import lombok.RequiredArgsConstructor; +import lombok.ToString; +import org.jspecify.annotations.Nullable; +import org.openrewrite.*; +import org.openrewrite.quark.Quark; +import org.openrewrite.scheduling.WorkingDirectoryExecutionContextView; +import org.openrewrite.text.PlainText; +import org.openrewrite.tree.ParseError; + +import java.io.File; +import java.io.IOException; +import java.io.UncheckedIOException; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.nio.file.*; +import java.nio.file.attribute.BasicFileAttributes; +import java.util.*; +import java.util.concurrent.TimeUnit; + +abstract class UpgradeAssistantRecipe extends ScanningRecipe { + private static final String FIRST_RECIPE = UpgradeAssistantRecipe.class.getName() + ".FIRST_RECIPE"; + private static final String PREVIOUS_RECIPE = UpgradeAssistantRecipe.class.getName() + ".PREVIOUS_RECIPE"; + private static final String INIT_REPO_DIR = UpgradeAssistantRecipe.class.getName() + ".INIT_REPO_DIR"; + private static final String UPGRADE_ASSISTANT = "upgrade-assistant"; + protected static final String DOTNET_HOME = System.getProperty("user.home") + File.separator + ".dotnet"; + + @Override + public Accumulator getInitialValue(ExecutionContext ctx) { + Path directory = createDirectory(ctx); + if (ctx.getMessage(INIT_REPO_DIR) == null) { + ctx.putMessage(INIT_REPO_DIR, directory); + ctx.putMessage(FIRST_RECIPE, ctx.getCycleDetails().getRecipePosition()); + } + return new Accumulator(directory); + } + + @Override + public TreeVisitor getScanner(Accumulator acc) { + return new TreeVisitor() { + @Override + public @Nullable Tree visit(@Nullable Tree tree, ExecutionContext ctx) { + if (tree instanceof SourceFile && !(tree instanceof Quark) && !(tree instanceof ParseError)) { + SourceFile sourceFile = (SourceFile) tree; + + // Only extract initial source files for first upgrade-assistant recipe + if (Objects.equals(ctx.getMessage(FIRST_RECIPE), ctx.getCycleDetails().getRecipePosition())) { + acc.writeSource(sourceFile); + } + } + return tree; + } + }; + } + + @Override + public Collection generate(Accumulator acc, ExecutionContext ctx) { + Path previous = ctx.getMessage(PREVIOUS_RECIPE); + if (previous != null && + !Objects.equals(ctx.getMessage(FIRST_RECIPE), ctx.getCycleDetails().getRecipePosition())) { + acc.copyFromPrevious(previous); + } + + if (ctx.getCycle() == 1) { + // upgrade-assistant run more than once on a project will log an "Unknown target framework" message + runUpgradeAssistant(acc, ctx); + } + + ctx.putMessage(PREVIOUS_RECIPE, acc.getDirectory()); + + return Collections.emptyList(); + } + + abstract public void runUpgradeAssistant(Accumulator acc, ExecutionContext ctx); + + protected void execUpgradeAssistant(Path inputFile, Accumulator acc, ExecutionContext ctx) { + List command = buildUpgradeAssistantCommand(acc, ctx, inputFile); + Path out = null; + Path err = null; + + try { + ProcessBuilder builder = new ProcessBuilder(); + builder.command(command); + builder.directory(acc.getDirectory().toFile()); + Map env = buildUpgradeAssistantEnv(); + env.forEach(builder.environment()::put); + + out = Files.createTempFile( + WorkingDirectoryExecutionContextView.view(ctx).getWorkingDirectory(), + UPGRADE_ASSISTANT, + null); + err = Files.createTempFile( + WorkingDirectoryExecutionContextView.view(ctx).getWorkingDirectory(), + UPGRADE_ASSISTANT, + null); + builder.redirectOutput(ProcessBuilder.Redirect.to(out.toFile())); + builder.redirectError(ProcessBuilder.Redirect.to(err.toFile())); + + Process process = builder.start(); + process.waitFor(20, TimeUnit.MINUTES); + if (process.exitValue() != 0) { + String error = "Command failed: " + String.join(" ", command); + if (Files.exists(err)) { + error += "\n" + new String(Files.readAllBytes(err)); + } + throw new RuntimeException(error); + } else { + for (Map.Entry entry : acc.beforeModificationTimestamps.entrySet()) { + Path path = entry.getKey(); + if (!Files.exists(path) || Files.getLastModifiedTime(path).toMillis() > entry.getValue()) { + acc.addModifiedFile(path); + } + } + processOutput(inputFile, out, acc); + } + } catch ( + IOException e) { + throw new UncheckedIOException(e); + } catch ( + InterruptedException e) { + throw new RuntimeException(e); + } finally { + deleteFile(out); + deleteFile(err); + } + } + + private Map buildUpgradeAssistantEnv() { + Map env = new HashMap<>(); + env.put("TERM", "dumb"); + String path = System.getenv("PATH"); + // This is required to find .NET SDKs + env.put("PATH", path + File.pathSeparator + DOTNET_HOME); + return env; + } + + protected void deleteFile(@Nullable Path path) { + if (path != null) { + try { + Files.deleteIfExists(path); + } catch (IOException e) { + // FIXME recipe logger? + } + } + } + + abstract public List buildUpgradeAssistantCommand(Accumulator acc, ExecutionContext ctx, Path projectFile); + + protected Path getUpgradeAssistantPath() { + String cmdName = UPGRADE_ASSISTANT; + if (System.getProperty("os.name").contains("Windows")) { + cmdName += ".exe"; + } + + // Look for upgrade-assistant in conventional installation locations + Path cmdPath = Paths.get(DOTNET_HOME).resolve("tools").resolve(cmdName); + if (Files.exists(cmdPath)) { + return cmdPath; + } + + for (String path : System.getenv("PATH").split(File.pathSeparator)) { + cmdPath = Paths.get(path).resolve(cmdName); + if (Files.exists(cmdPath)) { + return cmdPath; + } + } + + throw new IllegalStateException("Unable to find " + cmdName + " on PATH"); + } + + abstract void processOutput(Path inputFile, Path output, Accumulator acc); + + @Override + public TreeVisitor getVisitor(Accumulator acc) { + return new TreeVisitor() { + @Override + public @Nullable Tree visit(@Nullable Tree tree, ExecutionContext ctx) { + if (tree instanceof SourceFile) { + SourceFile sourceFile = (SourceFile) tree; + return createAfter(sourceFile, acc, ctx); + } + return tree; + } + }; + } + + protected SourceFile createAfter(SourceFile before, Accumulator acc, ExecutionContext ctx) { + String error = acc.getFileError(acc.resolvedPath(before)); + if (error != null) { + throw new RecipeException(error); + } + + if (!acc.wasModified(before)) { + return before; + } + + return new PlainText( + before.getId(), + before.getSourcePath(), + before.getMarkers(), + Optional.ofNullable(before.getCharset()).map(Charset::name).orElse(null), + before.isCharsetBomMarked(), + before.getFileAttributes(), + null, + acc.content(before), + Collections.emptyList()); + } + + private static Path createDirectory(ExecutionContext ctx) { + WorkingDirectoryExecutionContextView view = WorkingDirectoryExecutionContextView.view(ctx); + return Optional.of(view.getWorkingDirectory()).map(d -> d.resolve("repo")).map(d -> { + try { + return Files.createDirectory(d).toRealPath(); + } catch (IOException e) { + throw new UncheckedIOException(e); + } + }).orElseThrow(() -> new IllegalStateException("Failed to create working directory for repo")); + } + + @ToString + @EqualsAndHashCode + @RequiredArgsConstructor + public static class Accumulator { + @Getter + private final Path directory; + + private final Map> fileResults = new HashMap<>(); + private final Map fileErrors = new HashMap<>(); + + @Getter + private final Map beforeModificationTimestamps = new HashMap<>(); + + private final Set modified = new LinkedHashSet<>(); + + @Getter + private final List projectFiles = new ArrayList<>(); + + @Getter + private final List solutionFiles = new ArrayList<>(); + + private final Map rules = new HashMap<>(); + + private void copyFromPrevious(Path previous) { + try { + Files.walkFileTree(previous, new SimpleFileVisitor() { + @Override + public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException { + Path target = directory.resolve(previous.relativize(dir)); + if (!target.equals(directory)) { + Files.createDirectory(target); + } + return FileVisitResult.CONTINUE; + } + + @Override + public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException { + try { + Path target = directory.resolve(previous.relativize(file)); + Files.copy(file, target); + beforeModificationTimestamps.put(target, Files.getLastModifiedTime(target).toMillis()); + } catch (NoSuchFileException ignore) { + } + return FileVisitResult.CONTINUE; + } + }); + } catch (IOException e) { + throw new UncheckedIOException(e); + } + } + + private void writeSource(SourceFile sourceFile) { + try { + Path path = resolvedPath(sourceFile); + Files.createDirectories(path.getParent()); + PrintOutputCapture.MarkerPrinter markerPrinter = new PrintOutputCapture.MarkerPrinter() { + }; + Path written = Files.write( + path, + sourceFile.printAll(new PrintOutputCapture<>(0, markerPrinter)) + .getBytes(Optional.ofNullable(sourceFile.getCharset()).orElse(StandardCharsets.UTF_8))); + beforeModificationTimestamps.put(written, Files.getLastModifiedTime(written).toMillis()); + String pathString = written.toString(); + if (isProjectFile(pathString)) { + projectFiles.add(written); + } else if (isSolutionFile(pathString)) { + solutionFiles.add(written); + } + } catch (IOException e) { + throw new UncheckedIOException(e); + } + } + + private boolean isProjectFile(String pathString) { + return pathString.endsWith(".csproj") || pathString.endsWith(".vbproj") || pathString.endsWith(".fsproj"); + } + + private boolean isSolutionFile(String pathString) { + return pathString.endsWith(".sln"); + } + + private void addModifiedFile(Path path) { + modified.add(path); + } + + private boolean wasModified(SourceFile tree) { + return modified.contains(resolvedPath(tree)); + } + + public String content(SourceFile tree) { + try { + Path path = resolvedPath(tree); + return tree.getCharset() != null ? + new String(Files.readAllBytes(path), tree.getCharset()) : + new String(Files.readAllBytes(path)); + } catch (IOException e) { + throw new UncheckedIOException(e); + } + } + + public Path resolvedPath(SourceFile tree) { + return directory.resolve(tree.getSourcePath()); + } + + public void addFileResult(Path path, JsonNode jsonNode) { + fileResults.computeIfAbsent(path, key -> new ArrayList<>()).add(jsonNode); + } + + public @Nullable List getFileResults(Path path) { + return fileResults.get(path); + } + + public void addFileError(Path path, String error) { + fileErrors.put(path, error); + } + + public @Nullable String getFileError(Path path) { + return fileErrors.get(path); + } + + public void addRule(String ruleId, JsonNode jsonNode) { + rules.put(ruleId, jsonNode); + } + + public String getRuleLabel(String ruleId) { + return rules.get(ruleId).get("label").asText(); + } + } +} diff --git a/src/main/java/org/openrewrite/dotnet/package-info.java b/src/main/java/org/openrewrite/dotnet/package-info.java new file mode 100644 index 0000000..978a233 --- /dev/null +++ b/src/main/java/org/openrewrite/dotnet/package-info.java @@ -0,0 +1,19 @@ +/* + * Copyright 2024 the original author or authors. + *

+ * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + *

+ * https://www.apache.org/licenses/LICENSE-2.0 + *

+ * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +@NullMarked +package org.openrewrite.dotnet; + +import org.jspecify.annotations.NullMarked; diff --git a/src/main/resources/META-INF/rewrite/category.yml b/src/main/resources/META-INF/rewrite/category.yml new file mode 100644 index 0000000..85158a8 --- /dev/null +++ b/src/main/resources/META-INF/rewrite/category.yml @@ -0,0 +1,22 @@ +# +# Copyright 2024 the original author or authors. +#

+# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +#

+# https://www.jackson.org/licenses/LICENSE-2.0 +#

+# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +--- +type: specs.openrewrite.org/v1beta/category +name: DotNet +packageName: org.openrewrite.dotnet +description: Recipes to migrate projects using .NET tools. +--- diff --git a/src/main/resources/META-INF/rewrite/dotnet.yml b/src/main/resources/META-INF/rewrite/dotnet.yml new file mode 100644 index 0000000..aeb50cf --- /dev/null +++ b/src/main/resources/META-INF/rewrite/dotnet.yml @@ -0,0 +1,39 @@ +# +# Copyright 2024 the original author or authors. +#

+# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +#

+# https://www.apache.org/licenses/LICENSE-2.0 +#

+# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--- +type: specs.openrewrite.org/v1beta/recipe +name: org.openrewrite.dotnet.MigrateToNet6 +recipeList: + - org.openrewrite.dotnet.UpgradeAssistant: + targetFramework: net6.0 +--- +type: specs.openrewrite.org/v1beta/recipe +name: org.openrewrite.dotnet.MigrateToNet7 +recipeList: + - org.openrewrite.dotnet.UpgradeAssistant: + targetFramework: net7.0 +--- +type: specs.openrewrite.org/v1beta/recipe +name: org.openrewrite.dotnet.MigrateToNet8 +recipeList: + - org.openrewrite.dotnet.UpgradeAssistant: + targetFramework: net8.0 +--- +type: specs.openrewrite.org/v1beta/recipe +name: org.openrewrite.dotnet.MigrateToNet9 +recipeList: + - org.openrewrite.dotnet.UpgradeAssistant: + targetFramework: net9.0 diff --git a/src/test/java/.editorconfig b/src/test/java/.editorconfig new file mode 100644 index 0000000..42a5c01 --- /dev/null +++ b/src/test/java/.editorconfig @@ -0,0 +1,6 @@ +root = true + +# Limit continuation indent to 2 spaces for Java files, as we heavily use continuations around our text blocks. +[*.java] +indent_size = 4 +ij_continuation_indent_size = 2 diff --git a/src/test/java/org/openrewrite/dotnet/UpgradeAssistantAnalyzeTest.java b/src/test/java/org/openrewrite/dotnet/UpgradeAssistantAnalyzeTest.java new file mode 100644 index 0000000..e83b2f4 --- /dev/null +++ b/src/test/java/org/openrewrite/dotnet/UpgradeAssistantAnalyzeTest.java @@ -0,0 +1,56 @@ +/* + * Copyright 2024 the original author or authors. + *

+ * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + *

+ * https://www.apache.org/licenses/LICENSE-2.0 + *

+ * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.openrewrite.dotnet; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.condition.DisabledIfEnvironmentVariable; +import org.openrewrite.DocumentExample; +import org.openrewrite.test.RewriteTest; + +import static org.openrewrite.test.SourceSpecs.text; + +@DisabledIfEnvironmentVariable(named = "CI", matches = "true") +class UpgradeAssistantAnalyzeTest implements RewriteTest { + + @DocumentExample + @Test + void analyzeSingleProject() { + rewriteRun( + spec -> spec.recipe(new UpgradeAssistantAnalyze("net9.0", null)), + text( + """ + + + net6.0 + + + """, + spec -> spec.path("src/Proj.csproj") + ), + text( + """ + Microsoft Visual Studio Solution File, Format Version 12.00 + # Visual Studio Version 16 + VisualStudioVersion = 16.0.29709.97 + MinimumVisualStudioVersion = 10.0.40219.1 + Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Proj", "src/Proj.csproj", "{38434103-76E0-4820-B4AF-F5EA5D08A7BD}" + EndProject + """, + spec -> spec.path("Proj.sln") + ) + ); + } +} diff --git a/src/test/java/org/openrewrite/dotnet/UpgradeAssistantTest.java b/src/test/java/org/openrewrite/dotnet/UpgradeAssistantTest.java new file mode 100644 index 0000000..c02bf6a --- /dev/null +++ b/src/test/java/org/openrewrite/dotnet/UpgradeAssistantTest.java @@ -0,0 +1,128 @@ +/* + * Copyright 2024 the original author or authors. + *

+ * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + *

+ * https://www.apache.org/licenses/LICENSE-2.0 + *

+ * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.openrewrite.dotnet; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.condition.DisabledIfEnvironmentVariable; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.CsvSource; +import org.openrewrite.DocumentExample; +import org.openrewrite.RecipeException; +import org.openrewrite.test.RewriteTest; + +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.openrewrite.test.SourceSpecs.text; + +@DisabledIfEnvironmentVariable(named = "CI", matches = "true") +class UpgradeAssistantTest implements RewriteTest { + + @DocumentExample + @ParameterizedTest + @CsvSource(textBlock = """ + net6.0, net7.0 + net6.0, net9.0 + net8.0, net9.0 + """) + void upgradeDotNetSingleProject(String currentVersion, String upgradedVersion) { + rewriteRun( + spec -> spec.recipe(new UpgradeAssistant(upgradedVersion)), + text( + """ + + + %s + + + """.formatted(currentVersion), + """ + + + %s + + + """.formatted(upgradedVersion), + spec -> spec.path("src/Proj.csproj") + ) + ); + } + + @ParameterizedTest + @CsvSource(textBlock = """ + net6.0, net7.0 + net6.0, net9.0 + net7.0, net8.0 + """) + void upgradeDotNetMultipleProject(String currentVersion, String upgradedVersion) { + rewriteRun( + spec -> spec.recipe(new UpgradeAssistant(upgradedVersion)), + text( + """ + + + %s + + + """.formatted(currentVersion), + """ + + + %s + + + """.formatted(upgradedVersion), + spec -> spec.path("src/Proj.csproj") + ), + text( + """ + + + %s + + + """.formatted(currentVersion), + """ + + + %s + + + """.formatted(upgradedVersion), + spec -> spec.path("src/ProjTest.csproj") + ) + ); + } + + @Test + void upgradeDotNetWithInvalidVersion() { + assertThatThrownBy(() -> + rewriteRun( + spec -> spec.recipe(new UpgradeAssistant("foo-bar")), + text( + """ + + + net6.0 + + + """, + spec -> spec.path("src/Proj.csproj") + ) + )) + .cause() + .isInstanceOf(RecipeException.class) + .hasMessageContaining("Unknown target framework"); + } +}