mirror of
https://gitflic.ru/project/openide/openide.git
synced 2026-09-27 10:03:11 +07:00
IJPL-930 Implement LibraryScopeCache tests
GitOrigin-RevId: 432042331b2a31e7aaaf5b91216b38b01402c307
This commit is contained in:
Ilya Korennoy
committed by
intellij-monorepo-bot
intellij-monorepo-bot
parent
b583e0fd5e
commit
0353eeec04
@@ -0,0 +1,260 @@
|
||||
// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
|
||||
package com.intellij.roots.libraries
|
||||
|
||||
import com.intellij.openapi.roots.DependencyScope
|
||||
import com.intellij.openapi.roots.ModuleRootModificationUtil
|
||||
import com.intellij.openapi.roots.OrderRootType
|
||||
import com.intellij.openapi.roots.impl.LibraryScopeCache
|
||||
import com.intellij.testFramework.junit5.RunInEdt
|
||||
import com.intellij.testFramework.junit5.TestApplication
|
||||
import com.intellij.testFramework.rules.ProjectModelExtension
|
||||
import org.jetbrains.jps.model.java.JavaSourceRootType
|
||||
import org.junit.jupiter.api.Assertions.*
|
||||
import org.junit.jupiter.api.Test
|
||||
import org.junit.jupiter.api.extension.RegisterExtension
|
||||
import org.junit.jupiter.params.ParameterizedTest
|
||||
import org.junit.jupiter.params.provider.Arguments
|
||||
import org.junit.jupiter.params.provider.MethodSource
|
||||
import java.util.stream.Stream
|
||||
|
||||
@TestApplication
|
||||
@RunInEdt(writeIntent = true)
|
||||
class LibraryScopeCacheTest {
|
||||
@JvmField
|
||||
@RegisterExtension
|
||||
val projectModel: ProjectModelExtension = ProjectModelExtension()
|
||||
|
||||
|
||||
@Test
|
||||
fun `library used in single module`() {
|
||||
val libraryScopeCache = LibraryScopeCache.getInstance(projectModel.project)
|
||||
val module = projectModel.createModule("moduleA")
|
||||
val libraryRoot = projectModel.baseProjectDir.newVirtualDirectory("lib")
|
||||
val libraryFile = projectModel.baseProjectDir.newVirtualFile("lib/Lib.class")
|
||||
val library = projectModel.addProjectLevelLibrary("testLib") {
|
||||
it.addRoot(libraryRoot, OrderRootType.CLASSES)
|
||||
}
|
||||
ModuleRootModificationUtil.addDependency(module, library)
|
||||
|
||||
val moduleSourceRoot = projectModel.addSourceRoot(module, "src", JavaSourceRootType.SOURCE)
|
||||
|
||||
val scope = libraryScopeCache.getLibraryScope(libraryRoot)
|
||||
|
||||
assertTrue(scope.contains(libraryFile), "Library scope should contain library files")
|
||||
assertTrue(scope.contains(moduleSourceRoot), "Library scope should contain module source that uses the library")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `library used in two modules with compile scope`() {
|
||||
val libraryScopeCache = LibraryScopeCache.getInstance(projectModel.project)
|
||||
val moduleA = projectModel.createModule("moduleA")
|
||||
val moduleB = projectModel.createModule("moduleB")
|
||||
|
||||
val libraryRoot = projectModel.baseProjectDir.newVirtualDirectory("lib")
|
||||
val library = projectModel.addProjectLevelLibrary("sharedLib") {
|
||||
it.addRoot(libraryRoot, OrderRootType.CLASSES)
|
||||
}
|
||||
|
||||
ModuleRootModificationUtil.addDependency(moduleA, library, DependencyScope.COMPILE, false)
|
||||
ModuleRootModificationUtil.addDependency(moduleB, library, DependencyScope.COMPILE, false)
|
||||
|
||||
val sourceRootA = projectModel.addSourceRoot(moduleA, "src", JavaSourceRootType.SOURCE)
|
||||
val sourceRootB = projectModel.addSourceRoot(moduleB, "src", JavaSourceRootType.SOURCE)
|
||||
|
||||
val scope = libraryScopeCache.getLibraryScope(libraryRoot)
|
||||
|
||||
assertTrue(scope.contains(sourceRootA), "Library scope should contain moduleA sources")
|
||||
assertTrue(scope.contains(sourceRootB), "Library scope should contain moduleB sources")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `library with test scope`() {
|
||||
val libraryScopeCache = LibraryScopeCache.getInstance(projectModel.project)
|
||||
val module = projectModel.createModule("moduleA")
|
||||
|
||||
val libraryRoot = projectModel.baseProjectDir.newVirtualDirectory("testLib")
|
||||
val library = projectModel.addProjectLevelLibrary("testScopeLib") {
|
||||
it.addRoot(libraryRoot, OrderRootType.CLASSES)
|
||||
}
|
||||
|
||||
ModuleRootModificationUtil.addDependency(module, library, DependencyScope.TEST, false)
|
||||
|
||||
val sourceRoot = projectModel.addSourceRoot(module, "src", JavaSourceRootType.SOURCE)
|
||||
|
||||
val scope = libraryScopeCache.getLibraryScope(libraryRoot)
|
||||
|
||||
assertTrue(scope.contains(sourceRoot), "Library scope should contain module sources even for TEST scope library")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `libraries only scope contains only library files`() {
|
||||
val libraryScopeCache = LibraryScopeCache.getInstance(projectModel.project)
|
||||
val module = projectModel.createModule("moduleA")
|
||||
|
||||
val libraryRoot = projectModel.baseProjectDir.newVirtualDirectory("lib")
|
||||
val libraryFile = projectModel.baseProjectDir.newVirtualFile("lib/Lib.class")
|
||||
val library = projectModel.addProjectLevelLibrary("onlyLib") {
|
||||
it.addRoot(libraryRoot, OrderRootType.CLASSES)
|
||||
}
|
||||
ModuleRootModificationUtil.addDependency(module, library)
|
||||
|
||||
projectModel.addSourceRoot(module, "src", JavaSourceRootType.SOURCE)
|
||||
val sourceFile = projectModel.baseProjectDir.newVirtualFile("moduleA/src/Main.java")
|
||||
|
||||
val librariesOnlyScope = libraryScopeCache.librariesOnlyScope
|
||||
|
||||
assertTrue(librariesOnlyScope.contains(libraryFile), "Libraries only scope should contain library files")
|
||||
assertFalse(librariesOnlyScope.contains(sourceFile), "Libraries only scope should NOT contain module source files")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `library scope with sources`() {
|
||||
val libraryScopeCache = LibraryScopeCache.getInstance(projectModel.project)
|
||||
val module = projectModel.createModule("moduleA")
|
||||
|
||||
val libraryClassesRoot = projectModel.baseProjectDir.newVirtualDirectory("lib/classes")
|
||||
val librarySourcesRoot = projectModel.baseProjectDir.newVirtualDirectory("lib/sources")
|
||||
val library = projectModel.addProjectLevelLibrary("libWithSources") {
|
||||
it.addRoot(libraryClassesRoot, OrderRootType.CLASSES)
|
||||
it.addRoot(librarySourcesRoot, OrderRootType.SOURCES)
|
||||
}
|
||||
ModuleRootModificationUtil.addDependency(module, library)
|
||||
|
||||
val scope = libraryScopeCache.getLibraryScope(libraryClassesRoot)
|
||||
|
||||
assertTrue(scope.contains(libraryClassesRoot), "Library scope should contain library classes")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `multiple modules with different dependency scopes on same library`() {
|
||||
val libraryScopeCache = LibraryScopeCache.getInstance(projectModel.project)
|
||||
val moduleA = projectModel.createModule("moduleA")
|
||||
val moduleB = projectModel.createModule("moduleB")
|
||||
val moduleC = projectModel.createModule("moduleC")
|
||||
|
||||
val libraryRoot = projectModel.baseProjectDir.newVirtualDirectory("lib")
|
||||
val library = projectModel.addProjectLevelLibrary("multiScopeLib") {
|
||||
it.addRoot(libraryRoot, OrderRootType.CLASSES)
|
||||
}
|
||||
|
||||
ModuleRootModificationUtil.addDependency(moduleA, library, DependencyScope.COMPILE, false)
|
||||
ModuleRootModificationUtil.addDependency(moduleB, library, DependencyScope.TEST, false)
|
||||
ModuleRootModificationUtil.addDependency(moduleC, library, DependencyScope.PROVIDED, false)
|
||||
|
||||
val sourceRootA = projectModel.addSourceRoot(moduleA, "src", JavaSourceRootType.SOURCE)
|
||||
val sourceRootB = projectModel.addSourceRoot(moduleB, "src", JavaSourceRootType.SOURCE)
|
||||
val sourceRootC = projectModel.addSourceRoot(moduleC, "src", JavaSourceRootType.SOURCE)
|
||||
|
||||
val scope = libraryScopeCache.getLibraryScope(libraryRoot)
|
||||
|
||||
assertTrue(scope.contains(sourceRootA), "Library scope should contain moduleA sources (COMPILE)")
|
||||
assertTrue(scope.contains(sourceRootB), "Library scope should contain moduleB sources (TEST)")
|
||||
assertTrue(scope.contains(sourceRootC), "Library scope should contain moduleC sources (PROVIDED)")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `library use scope includes dependent modules transitively`() {
|
||||
val libraryScopeCache = LibraryScopeCache.getInstance(projectModel.project)
|
||||
val moduleA = projectModel.createModule("moduleA")
|
||||
val moduleB = projectModel.createModule("moduleB")
|
||||
val moduleC = projectModel.createModule("moduleC")
|
||||
|
||||
val libraryRoot = projectModel.baseProjectDir.newVirtualDirectory("lib")
|
||||
val library = projectModel.addProjectLevelLibrary("chainLib") {
|
||||
it.addRoot(libraryRoot, OrderRootType.CLASSES)
|
||||
}
|
||||
|
||||
ModuleRootModificationUtil.addDependency(moduleC, library, DependencyScope.COMPILE, true)
|
||||
ModuleRootModificationUtil.addDependency(moduleB, moduleC, DependencyScope.COMPILE, true)
|
||||
ModuleRootModificationUtil.addDependency(moduleA, moduleB, DependencyScope.COMPILE, false)
|
||||
|
||||
val sourceRootA = projectModel.addSourceRoot(moduleA, "src", JavaSourceRootType.SOURCE)
|
||||
val sourceRootB = projectModel.addSourceRoot(moduleB, "src", JavaSourceRootType.SOURCE)
|
||||
val sourceRootC = projectModel.addSourceRoot(moduleC, "src", JavaSourceRootType.SOURCE)
|
||||
|
||||
val useScope = libraryScopeCache.getLibraryUseScope(libraryRoot)
|
||||
|
||||
assertTrue(useScope.contains(sourceRootC), "Library use scope should contain moduleC (direct dependency)")
|
||||
assertTrue(useScope.contains(sourceRootB), "Library use scope should contain moduleB (via exported from moduleC)")
|
||||
assertTrue(useScope.contains(sourceRootA), "Library use scope should contain moduleA (via exported chain)")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `module level library scope`() {
|
||||
val libraryScopeCache = LibraryScopeCache.getInstance(projectModel.project)
|
||||
val module = projectModel.createModule("moduleA")
|
||||
|
||||
val libraryRoot = projectModel.baseProjectDir.newVirtualDirectory("moduleLib")
|
||||
projectModel.addModuleLevelLibrary(module, "moduleLevelLib") {
|
||||
it.addRoot(libraryRoot, OrderRootType.CLASSES)
|
||||
}
|
||||
|
||||
val sourceRoot = projectModel.addSourceRoot(module, "src", JavaSourceRootType.SOURCE)
|
||||
val scope = libraryScopeCache.getLibraryScope(libraryRoot)
|
||||
assertTrue(scope.contains(sourceRoot), "Module-level library scope should contain the module's sources")
|
||||
}
|
||||
|
||||
@ParameterizedTest
|
||||
@MethodSource("scopeAndExportedCombinations")
|
||||
fun `library use scope with transitive dependency for different scopes`(scope: DependencyScope, exported: Boolean) {
|
||||
val libraryScopeCache = LibraryScopeCache.getInstance(projectModel.project)
|
||||
val moduleA = projectModel.createModule("moduleA")
|
||||
val moduleB = projectModel.createModule("moduleB")
|
||||
|
||||
val libraryRoot = projectModel.baseProjectDir.newVirtualDirectory("lib")
|
||||
val library = projectModel.addProjectLevelLibrary("transitiveLib") {
|
||||
it.addRoot(libraryRoot, OrderRootType.CLASSES)
|
||||
}
|
||||
|
||||
ModuleRootModificationUtil.addDependency(moduleB, library, scope, exported)
|
||||
ModuleRootModificationUtil.addDependency(moduleA, moduleB, scope, exported)
|
||||
|
||||
val sourceRootA = projectModel.addSourceRoot(moduleA, "src", JavaSourceRootType.SOURCE)
|
||||
val sourceRootB = projectModel.addSourceRoot(moduleB, "src", JavaSourceRootType.SOURCE)
|
||||
|
||||
val useScope = libraryScopeCache.getLibraryUseScope(libraryRoot)
|
||||
|
||||
assertTrue(useScope.contains(sourceRootB), "Library use scope should contain moduleB sources (direct dependency with scope=$scope)")
|
||||
assertTrue(useScope.contains(sourceRootA), "Library use scope should contain moduleA sources (moduleA depends on moduleB which uses the library)")
|
||||
}
|
||||
|
||||
@ParameterizedTest
|
||||
@MethodSource("scopeAndExportedCombinations")
|
||||
fun `library use scope with three modules transitive dependency chain`(scope: DependencyScope, exported: Boolean) {
|
||||
val libraryScopeCache = LibraryScopeCache.getInstance(projectModel.project)
|
||||
val moduleA = projectModel.createModule("moduleA")
|
||||
val moduleB = projectModel.createModule("moduleB")
|
||||
val moduleC = projectModel.createModule("moduleC")
|
||||
|
||||
val libraryRoot = projectModel.baseProjectDir.newVirtualDirectory("lib")
|
||||
val library = projectModel.addProjectLevelLibrary("chainLib") {
|
||||
it.addRoot(libraryRoot, OrderRootType.CLASSES)
|
||||
}
|
||||
|
||||
ModuleRootModificationUtil.addDependency(moduleC, library, scope, exported)
|
||||
// we should always export this dep
|
||||
ModuleRootModificationUtil.addDependency(moduleB, moduleC, scope, true)
|
||||
ModuleRootModificationUtil.addDependency(moduleA, moduleB, scope, exported)
|
||||
|
||||
val sourceRootA = projectModel.addSourceRoot(moduleA, "src", JavaSourceRootType.SOURCE)
|
||||
val sourceRootB = projectModel.addSourceRoot(moduleB, "src", JavaSourceRootType.SOURCE)
|
||||
val sourceRootC = projectModel.addSourceRoot(moduleC, "src", JavaSourceRootType.SOURCE)
|
||||
|
||||
val useScope = libraryScopeCache.getLibraryUseScope(libraryRoot)
|
||||
|
||||
assertTrue(useScope.contains(sourceRootC), "Library use scope should contain moduleC (direct dependency with scope=$scope, exported=$exported)")
|
||||
assertTrue(useScope.contains(sourceRootB), "Library use scope should contain moduleB (via exported from moduleC)")
|
||||
assertTrue(useScope.contains(sourceRootA), "Library use scope should contain moduleA (via exported chain)")
|
||||
}
|
||||
|
||||
companion object {
|
||||
@JvmStatic
|
||||
fun scopeAndExportedCombinations(): Stream<Arguments> =
|
||||
DependencyScope.entries.flatMap { scope ->
|
||||
listOf(true, false).map { exported ->
|
||||
Arguments.of(scope, exported)
|
||||
}
|
||||
}.stream()
|
||||
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user