Skip to content

Fix for an issue were -PdependencyLock.useGeneratedLock=true is ignored #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix for an issue were -PdependencyLock.useGeneratedLock=true is ignored #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 47 additions & 53 deletions src/main/groovy/nebula/plugin/dependencylock/DependencyLockPlugin.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ class DependencyLockPlugin implements Plugin<Project> {
public static final String UPDATE_GLOBAL_LOCK_TASK_NAME = 'updateGlobalLock'
public static final String GENERATE_LOCK_TASK_NAME = 'generateLock'
public static final String UPDATE_LOCK_TASK_NAME = 'updateLock'
public static final String SAVE_LOCK_TASK_NAME = 'saveLock'
public static final String SAVE_GLOBAL_LOCK_TASK_NAME = 'saveGlobalLock'

Project project

Expand All @@ -71,8 +73,7 @@ class DependencyLockPlugin implements Plugin<Project> {
}

Map overrides = loadOverrides()
String globalLockFilename = project.hasProperty(GLOBAL_LOCK_FILE) ? project[GLOBAL_LOCK_FILE] : null
String lockFilename = configureTasks(globalLockFilename, extension, commitExtension, overrides)
configureTasks(extension, commitExtension, overrides)

def lockAfterEvaluating = project.hasProperty(LOCK_AFTER_EVALUATING) ? Boolean.parseBoolean(project[LOCK_AFTER_EVALUATING] as String) : extension.lockAfterEvaluating
if (lockAfterEvaluating) {
Expand All @@ -90,10 +91,10 @@ class DependencyLockPlugin implements Plugin<Project> {
project.configurations.all({ conf ->
if (lockAfterEvaluating) {
conf.incoming.beforeResolve {
maybeApplyLock(conf, extension, overrides, globalLockFilename, lockFilename)
maybeApplyLock(conf, extension, overrides)
}
} else {
maybeApplyLock(conf, extension, overrides, globalLockFilename, lockFilename)
maybeApplyLock(conf, extension, overrides)
}
})
}
Expand All @@ -111,44 +112,44 @@ class DependencyLockPlugin implements Plugin<Project> {
}
}

private String configureTasks(String globalLockFilename, DependencyLockExtension extension, DependencyLockCommitExtension commitExtension, Map overrides) {
String lockFilename = project.hasProperty(LOCK_FILE) ? project[LOCK_FILE] : null
private void configureTasks(DependencyLockExtension extension, DependencyLockCommitExtension commitExtension, Map overrides) {
File lockFile = project.hasProperty(LOCK_FILE) ? new File(project.projectDir, project[LOCK_FILE]) : null

GenerateLockTask genLockTask = project.tasks.create(GENERATE_LOCK_TASK_NAME, GenerateLockTask)
configureLockTask(genLockTask, lockFilename, extension, overrides)
configureLockTask(genLockTask, lockFile, extension, overrides)
if (project.hasProperty(USE_GENERATED_LOCK)) {
lockFilename = genLockTask.getDependenciesLock().path
lockFile = genLockTask.getDependenciesLock()
}

UpdateLockTask updateLockTask = project.tasks.create(UPDATE_LOCK_TASK_NAME, UpdateLockTask)
configureLockTask(updateLockTask, lockFilename, extension, overrides)
configureLockTask(updateLockTask, lockFile, extension, overrides)

SaveLockTask saveTask = configureSaveTask(lockFilename, genLockTask, updateLockTask, extension)
SaveLockTask saveTask = configureSaveTask(lockFile, genLockTask, updateLockTask, extension)
createDeleteLock(saveTask)

// configure global lock only on rootProject
SaveLockTask globalSave = null
GenerateLockTask globalLockTask
UpdateLockTask globalUpdateLock
if (project == project.rootProject) {
File globalLockFile = project.hasProperty(GLOBAL_LOCK_FILE) ? new File(project.rootProject.projectDir, project[GLOBAL_LOCK_FILE]) : null

globalLockTask = project.tasks.create(GENERATE_GLOBAL_LOCK_TASK_NAME, GenerateLockTask)
configureGlobalLockTask(globalLockTask, globalLockFile, extension, overrides)

if (project.hasProperty(USE_GENERATED_GLOBAL_LOCK)) {
globalLockFilename = globalLockTask.getDependenciesLock().path
globalLockFile = globalLockTask.getDependenciesLock()
}
configureGlobalLockTask(globalLockTask, globalLockFilename, extension, overrides)
globalUpdateLock = project.tasks.create(UPDATE_GLOBAL_LOCK_TASK_NAME, UpdateLockTask)
configureGlobalLockTask(globalUpdateLock, globalLockFilename, extension, overrides)
globalSave = configureGlobalSaveTask(globalLockFilename, globalLockTask, globalUpdateLock, extension)
configureGlobalLockTask(globalUpdateLock, globalLockFile, extension, overrides)
globalSave = configureGlobalSaveTask(globalLockFile, globalLockTask, globalUpdateLock, extension)
createDeleteGlobalLock(globalSave)
}

configureCommitTask(lockFilename, globalLockFilename, saveTask, extension, commitExtension, globalSave)

lockFilename
configureCommitTask(saveTask, commitExtension, globalSave)
}

private void configureCommitTask(String clLockFileName, String globalLockFileName, SaveLockTask saveTask, DependencyLockExtension lockExtension,
DependencyLockCommitExtension commitExtension, SaveLockTask globalSaveTask = null) {
private void configureCommitTask(SaveLockTask saveTask, DependencyLockCommitExtension commitExtension, SaveLockTask globalSaveTask) {
project.plugins.withType(ScmPlugin) {
if (!project.rootProject.tasks.findByName('commitLock')) {
CommitLockTask commitTask = project.rootProject.tasks.create('commitLock', CommitLockTask)
Expand All @@ -163,24 +164,12 @@ class DependencyLockPlugin implements Plugin<Project> {
project['commitDependencyLock.message'] : commitExtension.message
}
patternsToCommit = {
List<File> lockFiles = []
def rootLock = new File(project.rootProject.projectDir, clLockFileName ?: lockExtension.lockFile)
if (rootLock.exists()) {
lockFiles << rootLock
}
def globalLock = new File(project.rootProject.projectDir, globalLockFileName ?: lockExtension.globalLockFile)
if (globalLock.exists()) {
lockFiles << globalLock
}
project.rootProject.subprojects.each {
def potentialLock = new File(it.projectDir, clLockFileName ?: lockExtension.lockFile)
if (potentialLock.exists()) {
lockFiles << potentialLock
List<String> patterns = project.rootProject.allprojects.collect { pr ->
pr.tasks.withType(SaveLockTask).collect { slt ->
project.rootProject.relativePath(slt.outputLock)
}
}
def patterns = lockFiles.collect {
project.rootProject.projectDir.toURI().relativize(it.toURI()).path
}
}.flatten()

LOGGER.info(patterns.toString())
patterns
}
Expand All @@ -196,17 +185,17 @@ class DependencyLockPlugin implements Plugin<Project> {
}
}

private SaveLockTask configureSaveTask(String lockFileName, GenerateLockTask lockTask, UpdateLockTask updateTask, DependencyLockExtension extension) {
SaveLockTask saveTask = project.tasks.create('saveLock', SaveLockTask)
private SaveLockTask configureSaveTask(File lockFile, GenerateLockTask lockTask, UpdateLockTask updateTask, DependencyLockExtension extension) {
SaveLockTask saveTask = project.tasks.create(SAVE_LOCK_TASK_NAME, SaveLockTask)
saveTask.doFirst {
SaveLockTask globalSave = project.rootProject.tasks.findByName('saveGlobalLock') as SaveLockTask
SaveLockTask globalSave = project.rootProject.tasks.findByName(SAVE_GLOBAL_LOCK_TASK_NAME) as SaveLockTask
if (globalSave?.outputLock?.exists()) {
throw new GradleException('Cannot save individual locks when global lock is in place, run deleteGlobalLock task')
}
}
saveTask.conventionMapping.with {
generatedLock = { lockTask.dependenciesLock }
outputLock = { new File(project.projectDir, lockFileName ?: extension.lockFile) }
outputLock = { lockFile ?: new File(project.projectDir, extension.lockFile) }
}
configureCommonSaveTask(saveTask, lockTask, updateTask)

Expand All @@ -225,31 +214,31 @@ class DependencyLockPlugin implements Plugin<Project> {
}
}

private SaveLockTask configureGlobalSaveTask(String globalLockFileName, GenerateLockTask globalLockTask,
private SaveLockTask configureGlobalSaveTask(File globalLockFile, GenerateLockTask globalLockTask,
UpdateLockTask globalUpdateLockTask, DependencyLockExtension extension) {
SaveLockTask globalSaveTask = project.tasks.create('saveGlobalLock', SaveLockTask)
SaveLockTask globalSaveTask = project.tasks.create(SAVE_GLOBAL_LOCK_TASK_NAME, SaveLockTask)
globalSaveTask.doFirst {
project.subprojects.each { Project sub ->
SaveLockTask save = sub.tasks.findByName('saveLock') as SaveLockTask
SaveLockTask save = sub.tasks.findByName(SAVE_LOCK_TASK_NAME) as SaveLockTask
if (save && save.outputLock?.exists()) {
throw new GradleException('Cannot save global lock, one or more individual locks are in place, run deleteLock task')
}
}
}
globalSaveTask.conventionMapping.with {
generatedLock = { globalLockTask.dependenciesLock }
outputLock = { new File(project.projectDir, globalLockFileName ?: extension.globalLockFile) }
outputLock = { globalLockFile ?: new File(project.projectDir, extension.globalLockFile) }
}
configureCommonSaveTask(globalSaveTask, globalLockTask, globalUpdateLockTask)

globalSaveTask
}

private GenerateLockTask configureLockTask(GenerateLockTask lockTask, String clLockFileName, DependencyLockExtension extension, Map overrides) {
private GenerateLockTask configureLockTask(GenerateLockTask lockTask, File clLockFile, DependencyLockExtension extension, Map overrides) {
setupLockConventionMapping(lockTask, extension, overrides)
lockTask.conventionMapping.with {
dependenciesLock = {
new File(project.buildDir, clLockFileName ?: extension.lockFile)
clLockFile ?: new File(project.buildDir, extension.lockFile)
}
configurationNames = { extension.configurationNames }
}
Expand All @@ -268,14 +257,14 @@ class DependencyLockPlugin implements Plugin<Project> {
}
}

private GenerateLockTask configureGlobalLockTask(GenerateLockTask globalLockTask, String globalLockFileName, DependencyLockExtension extension, Map overrides) {
private GenerateLockTask configureGlobalLockTask(GenerateLockTask globalLockTask, File globalLockFile, DependencyLockExtension extension, Map overrides) {
setupLockConventionMapping(globalLockTask, extension, overrides)
globalLockTask.doFirst {
project.subprojects.each { sub -> sub.repositories.each { repo -> project.repositories.add(repo) } }
}
globalLockTask.conventionMapping.with {
dependenciesLock = {
new File(project.buildDir, globalLockFileName ?: extension.globalLockFile)
globalLockFile ?: new File(project.buildDir, extension.globalLockFile)
}
configurations = {
def subprojects = project.subprojects.collect { subproject ->
Expand Down Expand Up @@ -312,13 +301,18 @@ class DependencyLockPlugin implements Plugin<Project> {
}
}

private void maybeApplyLock(Configuration conf, DependencyLockExtension extension, Map overrides, String globalLockFileName, String lockFilename) {
private void maybeApplyLock(Configuration conf, DependencyLockExtension extension, Map overrides) {

SaveLockTask save = project.tasks.findByName(SAVE_LOCK_TASK_NAME) as SaveLockTask
SaveLockTask saveGlobal = project.rootProject.tasks.findByName(SAVE_GLOBAL_LOCK_TASK_NAME) as SaveLockTask

File dependenciesLock
File globalLock = new File(project.rootProject.projectDir, globalLockFileName ?: extension.globalLockFile)
if (globalLock.exists()) {

File globalLock = saveGlobal?.outputLock
if (globalLock && globalLock.exists()) {
dependenciesLock = globalLock
} else {
dependenciesLock = new File(project.projectDir, lockFilename ?: extension.lockFile)
dependenciesLock = save.outputLock
}

boolean appliedLock = false
Expand Down Expand Up @@ -376,7 +370,7 @@ class DependencyLockPlugin implements Plugin<Project> {
}

void applyLock(Configuration conf, File dependenciesLock, Map overrides, Collection<String> updates = []) {
LOGGER.info("Using ${dependenciesLock.name} to lock dependencies in $conf")
LOGGER.info("Using ${project.relativePath(dependenciesLock)} to lock dependencies in $conf")
def locks = loadLock(dependenciesLock)

if (updates) {
Expand Down
85 changes: 79 additions & 6 deletions src/test/groovy/nebula/plugin/dependencylock/DependencyLockLauncherSpec.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,27 +312,99 @@ class DependencyLockLauncherSpec extends IntegrationSpec {
}

def 'run with generated lock'() {
def dependenciesLock = new File(projectDir, 'dependencies.lock')
dependenciesLock << OLD_FOO_LOCK
def generatedLock = new File(projectDir, 'build/dependencies.lock')
generatedLock.parentFile.mkdirs()
generatedLock << OLD_FOO_LOCK
buildFile << BUILD_GRADLE

when:
runTasksSuccessfully('generateLock')
def result0 = runTasksSuccessfully('dependencies')

then:
new File(projectDir, 'build/dependencies.lock').text == FOO_LOCK
result0.standardOutput.contains 'test.example:foo:1.+ -> 1.0.1'

when:
def result1 = runTasksSuccessfully('-PdependencyLock.useGeneratedLock=true', 'dependencies')

then:
result1.standardOutput.contains "Using build/dependencies.lock to lock dependencies"
result1.standardOutput.contains 'test.example:foo:1.+ -> 1.0.0'
}


def 'run with generated global lock in single project'() {
def generatedLock = new File(projectDir, 'build/global.lock')
generatedLock.parentFile.mkdirs()
generatedLock << OLD_FOO_LOCK
buildFile << BUILD_GRADLE

when:
def result0 = runTasksSuccessfully('dependencies')

then:
result0.standardOutput.contains 'test.example:foo:1.+ -> 1.0.0'
result0.standardOutput.contains 'test.example:foo:1.+ -> 1.0.1'

when:
def result1 = runTasksSuccessfully('-PdependencyLock.useGeneratedLock=true', 'dependencies')
def result1 = runTasksSuccessfully('-PdependencyLock.useGeneratedGlobalLock=true', 'dependencies')

then:
result1.standardOutput.contains "Using build/global.lock to lock dependencies"
result1.standardOutput.contains 'test.example:foo:1.+ -> 1.0.0'
}


def 'run with generated global lock in multiproject'() {
def generatedLock = new File(projectDir, 'build/global.lock')
generatedLock.parentFile.mkdirs()
generatedLock << OLD_FOO_LOCK

addSubproject('sub1', """\
dependencies {
compile 'test.example:foo:2.+'
}
""".stripIndent())
addSubproject('sub2', """\
dependencies {
compile 'test.example:foo:1.+'
}
""".stripIndent())

buildFile << """\
allprojects {
${applyPlugin(DependencyLockPlugin)}
group = 'test'
}
subprojects {
repositories { maven { url '${Fixture.repo}' } }
apply plugin: 'java'
}
""".stripIndent()

when:
def result0 = runTasksSuccessfully(':sub1:dependencies')

then:
result0.standardOutput.contains 'test.example:foo:2.+ -> 2.0.1'

when:
def result1 = runTasksSuccessfully(':sub2:dependencies')

then:
result1.standardOutput.contains 'test.example:foo:1.+ -> 1.0.1'

when:
def result2 = runTasksSuccessfully('-PdependencyLock.useGeneratedGlobalLock=true', ':sub1:dependencies')

then:
result2.standardOutput.contains "Using ../build/global.lock to lock dependencies"
result2.standardOutput.contains 'test.example:foo:2.+ -> 1.0.0'

when:
def result3 = runTasksSuccessfully('-PdependencyLock.useGeneratedGlobalLock=true', ':sub2:dependencies')

then:
result3.standardOutput.contains "Using ../build/global.lock to lock dependencies"
result3.standardOutput.contains 'test.example:foo:1.+ -> 1.0.0'
}

def 'generateLock with deprecated format existing causes no issues'() {
Expand All @@ -356,6 +428,7 @@ class DependencyLockLauncherSpec extends IntegrationSpec {
def result1 = runTasksSuccessfully('-PdependencyLock.useGeneratedLock=true', 'dependencies')

then:
result1.standardOutput.contains "Using build/dependencies.lock to lock dependencies"
result1.standardOutput.contains 'test.example:foo:1.+ -> 1.0.1'
}

Expand Down