Skip to content

Commit

Permalink
#1779 Fixes compatibility with Gradle dependency verification. Previo…
Browse files Browse the repository at this point in the history 
…usly it was failing with "Failed to create MD5 hash for file".
  • Loading branch information
@AlexanderBartash
AlexanderBartash committed Oct 2, 2024
1 parent dbc44d9 commit f421238
Show file tree
Hide file tree
Showing 14 changed files with 154 additions and 36 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
### Fixed

- Fixed issue #1778 by removing a hash of the absolute artifact path appended to the end of the version string. That hash made artifact version different on different PCs and also breaks Gradle dependency locking.
- #1779 Fixes compatibility with Gradle dependency verification. Previously it was failing with "Failed to create MD5 hash for file".

## [2.1.0]

Expand Down
20 changes: 16 additions & 4 deletions api/IntelliJPlatformGradlePlugin.api
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ public final class org/jetbrains/intellij/platform/gradle/Constants$Configuratio
}

public final class org/jetbrains/intellij/platform/gradle/Constants$Configurations$Dependencies {
public static final field BUNDLED_MODULE_ARTIFACT_GROUP Ljava/lang/String;
public static final field BUNDLED_MODULE_GROUP Ljava/lang/String;
public static final field BUNDLED_PLUGIN_ARTIFACT_GROUP Ljava/lang/String;
public static final field BUNDLED_PLUGIN_GROUP Ljava/lang/String;
public static final field INSTANCE Lorg/jetbrains/intellij/platform/gradle/Constants$Configurations$Dependencies;
public static final field LOCAL_IDE_GROUP Ljava/lang/String;
Expand Down Expand Up @@ -164,6 +166,11 @@ public final class org/jetbrains/intellij/platform/gradle/Constants$Plugins$Exte
public static final field KOTLIN Ljava/lang/String;
}

public final class org/jetbrains/intellij/platform/gradle/Constants$RepositoryNames {
public static final field INSTANCE Lorg/jetbrains/intellij/platform/gradle/Constants$RepositoryNames;
public static final field LOCAL_IVY Ljava/lang/String;
}

public final class org/jetbrains/intellij/platform/gradle/Constants$Sandbox {
public static final field CONFIG Ljava/lang/String;
public static final field CONTAINER Ljava/lang/String;
Expand Down Expand Up @@ -461,7 +468,7 @@ public abstract class org/jetbrains/intellij/platform/gradle/attributes/Distribu

public abstract class org/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformDependenciesExtension {
public static final field Companion Lorg/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformDependenciesExtension$Companion;
public fun <init> (Lorg/gradle/api/artifacts/ConfigurationContainer;Lorg/gradle/api/artifacts/dsl/DependencyHandler;Lorg/gradle/api/file/ProjectLayout;Lorg/gradle/api/model/ObjectFactory;Lorg/gradle/api/provider/ProviderFactory;Lorg/gradle/api/resources/ResourceHandler;Ljava/nio/file/Path;)V
public fun <init> (Lorg/gradle/api/artifacts/dsl/RepositoryHandler;Lorg/gradle/api/artifacts/ConfigurationContainer;Lorg/gradle/api/artifacts/dsl/DependencyHandler;Lorg/gradle/api/file/ProjectLayout;Lorg/gradle/api/model/ObjectFactory;Lorg/gradle/api/provider/ProviderFactory;Lorg/gradle/api/resources/ResourceHandler;Ljava/nio/file/Path;)V
public final fun androidStudio (Ljava/lang/String;)V
public final fun androidStudio (Ljava/lang/String;Z)V
public final fun androidStudio (Lorg/gradle/api/provider/Provider;)V
Expand Down Expand Up @@ -685,7 +692,7 @@ public final class org/jetbrains/intellij/platform/gradle/extensions/IntelliJPla
}

public final class org/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformDependenciesHelper {
public fun <init> (Lorg/gradle/api/artifacts/ConfigurationContainer;Lorg/gradle/api/artifacts/dsl/DependencyHandler;Lorg/gradle/api/file/ProjectLayout;Lorg/gradle/api/model/ObjectFactory;Lorg/gradle/api/provider/ProviderFactory;Lorg/gradle/api/resources/ResourceHandler;Ljava/nio/file/Path;)V
public fun <init> (Lorg/gradle/api/artifacts/dsl/RepositoryHandler;Lorg/gradle/api/artifacts/ConfigurationContainer;Lorg/gradle/api/artifacts/dsl/DependencyHandler;Lorg/gradle/api/file/ProjectLayout;Lorg/gradle/api/model/ObjectFactory;Lorg/gradle/api/provider/ProviderFactory;Lorg/gradle/api/resources/ResourceHandler;Ljava/nio/file/Path;)V
}

public abstract class org/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformExtension : org/gradle/api/plugins/ExtensionAware {
Expand Down Expand Up @@ -806,7 +813,7 @@ public final class org/jetbrains/intellij/platform/gradle/extensions/IntelliJPla

public abstract class org/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformExtension$PluginVerification$Ides {
public static final field Companion Lorg/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformExtension$PluginVerification$Ides$Companion;
public fun <init> (Lorg/gradle/api/artifacts/ConfigurationContainer;Lorg/gradle/api/artifacts/dsl/DependencyHandler;Lorg/gradle/api/file/ProjectLayout;Lorg/gradle/api/model/ObjectFactory;Lorg/gradle/api/provider/ProviderFactory;Lorg/gradle/api/resources/ResourceHandler;Ljava/nio/file/Path;Lorg/gradle/api/provider/Provider;)V
public fun <init> (Lorg/gradle/api/artifacts/dsl/RepositoryHandler;Lorg/gradle/api/artifacts/ConfigurationContainer;Lorg/gradle/api/artifacts/dsl/DependencyHandler;Lorg/gradle/api/file/ProjectLayout;Lorg/gradle/api/model/ObjectFactory;Lorg/gradle/api/provider/ProviderFactory;Lorg/gradle/api/resources/ResourceHandler;Ljava/nio/file/Path;Lorg/gradle/api/provider/Provider;)V
public final fun ProductReleasesValueSource (Lkotlin/jvm/functions/Function1;)Lorg/gradle/api/provider/Provider;
public static synthetic fun ProductReleasesValueSource$default (Lorg/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformExtension$PluginVerification$Ides;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lorg/gradle/api/provider/Provider;
public final fun ide (Ljava/lang/String;)V
Expand Down Expand Up @@ -875,7 +882,7 @@ public abstract interface class org/jetbrains/intellij/platform/gradle/extension

public abstract class org/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformPluginsExtension : org/gradle/api/plugins/ExtensionAware {
public static final field Companion Lorg/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformPluginsExtension$Companion;
public fun <init> (Lorg/gradle/api/artifacts/ConfigurationContainer;Lorg/gradle/api/artifacts/dsl/DependencyHandler;Lorg/gradle/api/file/ProjectLayout;Lorg/gradle/api/model/ObjectFactory;Lorg/gradle/api/provider/ProviderFactory;Lorg/gradle/api/resources/ResourceHandler;Ljava/nio/file/Path;)V
public fun <init> (Lorg/gradle/api/artifacts/dsl/RepositoryHandler;Lorg/gradle/api/artifacts/ConfigurationContainer;Lorg/gradle/api/artifacts/dsl/DependencyHandler;Lorg/gradle/api/file/ProjectLayout;Lorg/gradle/api/model/ObjectFactory;Lorg/gradle/api/provider/ProviderFactory;Lorg/gradle/api/resources/ResourceHandler;Ljava/nio/file/Path;)V
public final fun disablePlugin (Ljava/lang/String;)V
public final fun disablePlugin (Lorg/gradle/api/provider/Provider;)V
public final fun disablePlugins (Ljava/util/List;)V
Expand Down Expand Up @@ -952,9 +959,14 @@ public final class org/jetbrains/intellij/platform/gradle/extensions/IntelliJPla
}

public final class org/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformRepositoriesHelper {
public static final field Companion Lorg/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformRepositoriesHelper$Companion;
public fun <init> (Lorg/gradle/api/artifacts/dsl/RepositoryHandler;Lorg/gradle/api/provider/ProviderFactory;Lorg/gradle/api/model/ObjectFactory;Lorg/gradle/api/flow/FlowScope;Lorg/gradle/api/flow/FlowProviders;Lorg/gradle/api/invocation/Gradle;Ljava/nio/file/Path;)V
}

public final class org/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformRepositoriesHelper$Companion {
public final fun updateLocalIvyRepoArtifactPattern (Ljava/nio/file/Path;Lorg/gradle/api/artifacts/dsl/RepositoryHandler;)V
}

public abstract class org/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformTestingExtension : org/gradle/api/plugins/ExtensionAware {
public static final field Companion Lorg/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformTestingExtension$Companion;
public fun <init> (Lorg/gradle/api/Project;)V
Expand Down
2 changes: 0 additions & 2 deletions ...org/jetbrains/intellij/platform/gradle/DependencyLockingAndVerificationIntegrationTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ class DependencyLockingAndVerificationIntegrationTest : IntelliJPlatformIntegrat
) {

@Test
@Ignore("https://github.com/JetBrains/intellij-platform-gradle-plugin/issues/1779")
fun `build plugin with dependency locks & hash verification`() {
build(
Tasks.External.CLEAN,
Expand All @@ -44,7 +43,6 @@ class DependencyLockingAndVerificationIntegrationTest : IntelliJPlatformIntegrat
}

@Test
@Ignore("https://github.com/JetBrains/intellij-platform-gradle-plugin/issues/1779")
fun `build plugin with dependency locks, hash & signature verification`() {
build(
Tasks.External.CLEAN,
Expand Down
1 change: 0 additions & 1 deletion ...jetbrains/intellij/platform/gradle/DependencyVerificationIgnoreIntellijIntegrationTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ class DependencyVerificationIgnoreIntellijIntegrationTest : IntelliJPlatformInte
}

@Test
@Ignore("https://github.com/JetBrains/intellij-platform-gradle-plugin/issues/1779")
fun `build plugin with dependency locks, hash & signature verification ignoring intellij artifacts`() {
build(
Tasks.External.CLEAN,
Expand Down
6 changes: 6 additions & 0 deletions src/main/kotlin/org/jetbrains/intellij/platform/gradle/Constants.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ object Constants {
const val LOCAL_JETBRAINS_RUNTIME_GROUP = "localJetBrainsRuntime"
const val BUNDLED_MODULE_GROUP = "bundledModule"
const val BUNDLED_PLUGIN_GROUP = "bundledPlugin"
const val BUNDLED_PLUGIN_ARTIFACT_GROUP = "bundledPluginArtifact"
const val BUNDLED_MODULE_ARTIFACT_GROUP = "bundledModuleArtifact"
const val MARKETPLACE_GROUP = "com.jetbrains.plugins"
}

Expand Down Expand Up @@ -174,6 +176,10 @@ object Constants {
const val LOG = "log"
}

object RepositoryNames {
const val LOCAL_IVY = "Local IntelliJ Platform Artifacts Repository"
}

object Locations {
const val CACHE_REDIRECTOR = "https://cache-redirector.jetbrains.com"
const val CACHE_REDIRECTOR_INTELLIJ_DEPENDENCIES_REPOSITORY = "$CACHE_REDIRECTOR/intellij-dependencies"
Expand Down
9 changes: 3 additions & 6 deletions ...kotlin/org/jetbrains/intellij/platform/gradle/artifacts/transform/CollectorTransformer.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,12 +87,9 @@ abstract class CollectorTransformer : TransformAction<CollectorTransformer.Param
}

isPlugin -> {
plugin.originalFile?.let { pluginPath ->
collectJars(
pluginPath.resolve("lib"),
pluginPath.resolve("lib/modules"),
).forEach { outputs.file(it) }
}
// Nothing to do, see:
// IntelliJPlatformRepositoriesHelper.Companion.updateLocalIvyRepoArtifactPattern
outputs.file(inputArtifact)
}

else -> throw GradleException("Unknown input: $path")
Expand Down
5 changes: 4 additions & 1 deletion ...rg/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformDependenciesExtension.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import org.gradle.api.artifacts.ConfigurationContainer
import org.gradle.api.artifacts.Dependency
import org.gradle.api.artifacts.ProjectDependency
import org.gradle.api.artifacts.dsl.DependencyHandler
import org.gradle.api.artifacts.dsl.RepositoryHandler
import org.gradle.api.file.Directory
import org.gradle.api.file.ProjectLayout
import org.gradle.api.model.ObjectFactory
Expand Down Expand Up @@ -51,6 +52,7 @@ import kotlin.io.path.absolute
@Suppress("unused", "MemberVisibilityCanBePrivate")
@IntelliJPlatform
abstract class IntelliJPlatformDependenciesExtension @Inject constructor(
repositories: RepositoryHandler,
configurations: ConfigurationContainer,
dependencies: DependencyHandler,
layout: ProjectLayout,
Expand All @@ -60,7 +62,7 @@ abstract class IntelliJPlatformDependenciesExtension @Inject constructor(
rootProjectDirectory: Path,
) {

private val delegate = IntelliJPlatformDependenciesHelper(configurations, dependencies, layout, objects, providers, resources, rootProjectDirectory)
private val delegate = IntelliJPlatformDependenciesHelper(repositories, configurations, dependencies, layout, objects, providers, resources, rootProjectDirectory)

/**
* Adds a dependency on the IntelliJ Platform.
Expand Down Expand Up @@ -1309,6 +1311,7 @@ abstract class IntelliJPlatformDependenciesExtension @Inject constructor(
override fun register(project: Project, target: Any) =
target.configureExtension<IntelliJPlatformDependenciesExtension>(
Extensions.INTELLIJ_PLATFORM,
project.repositories,
project.configurations,
project.dependencies,
project.layout,
Expand Down
29 changes: 21 additions & 8 deletions ...n/org/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformDependenciesHelper.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import org.gradle.api.artifacts.ConfigurationContainer
import org.gradle.api.artifacts.Dependency
import org.gradle.api.artifacts.ProjectDependency
import org.gradle.api.artifacts.dsl.DependencyHandler
import org.gradle.api.artifacts.dsl.RepositoryHandler
import org.gradle.api.file.Directory
import org.gradle.api.file.ProjectLayout
import org.gradle.api.model.ObjectFactory
Expand Down Expand Up @@ -55,6 +56,7 @@ import kotlin.io.path.*
* @param rootProjectDirectory The root directory of the Gradle project.
*/
class IntelliJPlatformDependenciesHelper(
private val repositories: RepositoryHandler,
private val configurations: ConfigurationContainer,
private val dependencies: DependencyHandler,
private val layout: ProjectLayout,
Expand Down Expand Up @@ -129,6 +131,11 @@ class IntelliJPlatformDependenciesHelper(
get() = platformPath.map { it.productInfo() }

private val bundledPlugins by lazy {
// Update artifact pattern in our Local Ivy Repo to use the extracted IDE path.
// It has to be done lazily here, since the IDE is unzipped by ExtractorTransformer during artifact resolution,
// and that path is not available when we register this repo initially.
IntelliJPlatformRepositoriesHelper.updateLocalIvyRepoArtifactPattern(platformPath.get(), repositories)

platformPath.get()
.resolve("plugins")
.listDirectoryEntries()
Expand Down Expand Up @@ -742,6 +749,8 @@ class IntelliJPlatformDependenciesHelper(
*/
private fun DependencyHandler.createIntelliJPlatformBundledPlugin(id: String): Dependency {
val plugin = bundledPlugins[id]
val platformPath by lazy { platformPath.get() }

requireNotNull(plugin) {
val unresolvedPluginId = when (id) {
"copyright" -> "Use correct plugin ID 'com.intellij.copyright' instead of 'copyright'."
Expand Down Expand Up @@ -769,8 +778,8 @@ class IntelliJPlatformDependenciesHelper(
module = id,
revision = version,
),
publications = listOf(artifactPath.toIvyArtifact()),
dependencies = plugin.collectDependencies(),
publications = artifactPath.toBundledPluginIvyArtifacts(platformPath),
dependencies = plugin.collectBundledPluginDependencies(),
)
}

Expand All @@ -791,7 +800,9 @@ class IntelliJPlatformDependenciesHelper(
.find { layout -> layout.name == id }
.let { requireNotNull(it) { "Specified bundledModule '$id' doesn't exist." } }
val platformPath = platformPath.get()
val artifactPaths = bundledModule.classPath.map { path -> platformPath.resolve(path).toIvyArtifact() }
val artifactPaths = bundledModule.classPath.flatMap { path ->
platformPath.resolve(path).toBundledModuleIvyArtifacts(platformPath)
}
val version = baseVersion.orElse(productInfo.map { it.version }).get()

writeIvyModule(Dependencies.BUNDLED_MODULE_GROUP, id, version) {
Expand All @@ -818,7 +829,7 @@ class IntelliJPlatformDependenciesHelper(
*
* @param path IDs of already traversed plugins or modules.
*/
private fun IdePlugin.collectDependencies(path: List<String> = emptyList()): List<IvyModule.Dependency> {
private fun IdePlugin.collectBundledPluginDependencies(path: List<String> = emptyList()): List<IvyModule.Dependency> {
val id = requireNotNull(pluginId)
val dependencyIds = (dependencies.map { it.id } + optionalDescriptors.map { it.dependency.id } + modulesDescriptors.map { it.name } - id).toSet()
val buildNumber by lazy { productInfo.get().buildNumber }
Expand All @@ -835,10 +846,10 @@ class IntelliJPlatformDependenciesHelper(
writeIvyModule(group, name, version) {
IvyModule(
info = IvyModule.Info(group, name, version),
publications = listOf(artifactPath.toIvyArtifact()),
publications = artifactPath.toBundledPluginIvyArtifacts(platformPath),
dependencies = when {
id in path -> emptyList()
else -> plugin.collectDependencies(path + id)
else -> plugin.collectBundledPluginDependencies(path + id)
},
)
}
Expand All @@ -855,7 +866,9 @@ class IntelliJPlatformDependenciesHelper(
.mapNotNull { layoutItems.find { layout -> layout.name == it } }
.filterNot { it.classPath.isEmpty() }
.map {
val artifactPaths = it.classPath.map { path -> platformPath.resolve(path).toIvyArtifact() }
val artifactPaths = it.classPath.flatMap { path ->
platformPath.resolve(path).toBundledModuleIvyArtifacts(platformPath)
}
val group = Dependencies.BUNDLED_MODULE_GROUP
val name = it.name
val version = buildNumber
Expand Down Expand Up @@ -904,7 +917,7 @@ class IntelliJPlatformDependenciesHelper(
module = name,
revision = version,
),
publications = listOf(artifactPath.toIvyArtifact()),
publications = artifactPath.toLocalPluginIvyArtifacts(),
)
}

Expand Down
4 changes: 4 additions & 0 deletions ...ain/kotlin/org/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformExtension.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import org.gradle.api.Action
import org.gradle.api.Project
import org.gradle.api.artifacts.ConfigurationContainer
import org.gradle.api.artifacts.dsl.DependencyHandler
import org.gradle.api.artifacts.dsl.RepositoryHandler
import org.gradle.api.file.Directory
import org.gradle.api.file.DirectoryProperty
import org.gradle.api.file.ProjectLayout
Expand Down Expand Up @@ -767,6 +768,7 @@ abstract class IntelliJPlatformExtension @Inject constructor(
*/
@IntelliJPlatform
abstract class Ides @Inject constructor(
repositories: RepositoryHandler,
configurations: ConfigurationContainer,
dependencies: DependencyHandler,
layout: ProjectLayout,
Expand All @@ -778,6 +780,7 @@ abstract class IntelliJPlatformExtension @Inject constructor(
) {

private val delegate = IntelliJPlatformDependenciesHelper(
repositories,
configurations,
dependencies,
layout,
Expand Down Expand Up @@ -950,6 +953,7 @@ abstract class IntelliJPlatformExtension @Inject constructor(
override fun register(project: Project, target: Any) =
target.configureExtension<Ides>(
Extensions.IDES,
project.repositories,
project.configurations,
project.dependencies,
project.layout,
Expand Down
4 changes: 4 additions & 0 deletions ...lin/org/jetbrains/intellij/platform/gradle/extensions/IntelliJPlatformPluginsExtension.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import org.gradle.api.Project
import org.gradle.api.artifacts.ConfigurationContainer
import org.gradle.api.artifacts.ProjectDependency
import org.gradle.api.artifacts.dsl.DependencyHandler
import org.gradle.api.artifacts.dsl.RepositoryHandler
import org.gradle.api.file.Directory
import org.gradle.api.file.ProjectLayout
import org.gradle.api.model.ObjectFactory
Expand All @@ -32,6 +33,7 @@ import javax.inject.Inject
*/
@IntelliJPlatform
abstract class IntelliJPlatformPluginsExtension @Inject constructor(
repositories: RepositoryHandler,
configurations: ConfigurationContainer,
dependencies: DependencyHandler,
layout: ProjectLayout,
Expand All @@ -45,6 +47,7 @@ abstract class IntelliJPlatformPluginsExtension @Inject constructor(
internal val intellijPlatformPluginLocalConfigurationName = objects.property<String>()

private val delegate = IntelliJPlatformDependenciesHelper(
repositories,
configurations,
dependencies,
layout,
Expand Down Expand Up @@ -242,6 +245,7 @@ abstract class IntelliJPlatformPluginsExtension @Inject constructor(
override fun register(project: Project, target: Any) =
target.configureExtension<IntelliJPlatformPluginsExtension>(
Extensions.PLUGINS,
project.repositories,
project.configurations,
project.dependencies,
project.layout,
Expand Down
Loading

0 comments on commit f421238

Please sign in to comment.