SpringCloud/spring-cloud-contract
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Allows multiple executions of the maven contract plugin; fixes gh-1807

Browse Source
This commit is contained in:
Marcin Grzejszczak
2022-07-11 12:27:45 +02:00
parent 414cd9c545
commit af20693084
3 changed files with 147 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
spring-cloud-contract-tools/spring-cloud-contract-maven-plugin/src/main/java/org/springframework/cloud/contract/maven/verifier/MavenContractsDownloader.java
View File

@@ -94,7 +94,7 @@ class MavenContractsDownloader {
}
File downloadAndUnpackContractsIfRequired(ContractVerifierConfigProperties config, File defaultContractsDir) {
String contractsDirFromProp = this.project.getProperties().getProperty(CONTRACTS_DIRECTORY_PROP);
String contractsDirFromProp = this.project.getProperties().getProperty(directoryProperty());
File downloadedContractsDir = StringUtils.hasText(contractsDirFromProp) ? new File(contractsDirFromProp) : null;
// reuse downloaded contracts from another mojo
if (downloadedContractsDir != null && downloadedContractsDir.exists()) {
@@ -114,19 +114,28 @@ class MavenContractsDownloader {
.createNewInclusionProperties(downloadedContracts);
config.setIncludedContracts(inclusionProperties.getIncludedContracts());
config.setIncludedRootFolderAntPattern(inclusionProperties.getIncludedRootFolderAntPattern());
this.project.getProperties().setProperty(CONTRACTS_DIRECTORY_PROP, downloadedContracts.getAbsolutePath());
this.project.getProperties().setProperty(directoryProperty(), downloadedContracts.getAbsolutePath());
return downloadedContracts;
}
this.log.info("Will use contracts provided in the folder [" + defaultContractsDir + "]");
return defaultContractsDir;
}
private String directoryProperty() {
if (this.contractDependency == null) {
return CONTRACTS_DIRECTORY_PROP;
}
return CONTRACTS_DIRECTORY_PROP + "_" + this.contractDependency.getGroupId() + ":"
+ this.contractDependency.getArtifactId() + ":" + this.contractDependency.getVersion() + ":"
+ this.contractDependency.getClassifier();
}
private boolean shouldDownloadContracts() {
return this.contractDependency != null && StringUtils.hasText(this.contractDependency.getArtifactId())
|| StringUtils.hasText(this.contractsRepositoryUrl);
}
private ContractDownloader contractDownloader() {
ContractDownloader contractDownloader() {
return new ContractDownloader(stubDownloader(), stubConfiguration(), this.contractsPath,
this.project.getGroupId(), this.project.getArtifactId(), this.project.getVersion());
}

110
spring-cloud-contract-tools/spring-cloud-contract-maven-plugin/src/test/java/org/springframework/cloud/contract/maven/verifier/MavenContractsDownloaderTests.java Normal file
View File

@@ -0,0 +1,110 @@
/*
* Copyright 2013-2020 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.springframework.cloud.contract.maven.verifier;
import java.io.File;
import java.util.HashMap;
import org.apache.maven.model.Dependency;
import org.apache.maven.plugin.testing.SilentLog;
import org.apache.maven.project.MavenProject;
import org.assertj.core.api.BDDAssertions;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import org.springframework.cloud.contract.stubrunner.ContractDownloader;
import org.springframework.cloud.contract.stubrunner.InclusionPropertiesAccessor;
import org.springframework.cloud.contract.stubrunner.spring.StubRunnerProperties;
import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties;
class MavenContractsDownloaderTests {
@TempDir
File defaultFolder;
@TempDir
File fileForDependencyOne;
@TempDir
File fileForDependencyTwo;
@Test
void shouldNotReadFolderFromCacheWhenExecutedTwiceFor2DifferentArtifactsInTheSameProject() {
MavenProject mavenProject = new MavenProject();
Dependency one = dependency(1);
MavenContractsDownloader mavenContractsDownloader = contractsDownloader(mavenProject, one,
this.fileForDependencyOne);
File dependencyOneFile = mavenContractsDownloader
.downloadAndUnpackContractsIfRequired(new ContractVerifierConfigProperties(), this.defaultFolder);
BDDAssertions.then(dependencyOneFile).as("Location for dependency 1 should be computed since it's not cached")
.isEqualTo(this.fileForDependencyOne);
mavenContractsDownloader = contractsDownloader(mavenProject, one, this.fileForDependencyOne);
File fileForDependencyOneAgain = mavenContractsDownloader
.downloadAndUnpackContractsIfRequired(new ContractVerifierConfigProperties(), this.defaultFolder);
BDDAssertions.then(dependencyOneFile).as("Location for dependency 1 should be taken from cache")
.isEqualTo(fileForDependencyOneAgain);
Dependency two = dependency(2);
mavenContractsDownloader = contractsDownloader(mavenProject, two, this.fileForDependencyTwo);
File dependencyTwoFile = mavenContractsDownloader
.downloadAndUnpackContractsIfRequired(new ContractVerifierConfigProperties(), this.defaultFolder);
BDDAssertions.then(dependencyTwoFile).as("Location for dependency 2 should be computed again")
.isNotEqualTo(dependencyOneFile).isEqualTo(this.fileForDependencyTwo);
}
private MavenContractsDownloader contractsDownloader(MavenProject mavenProject, Dependency one, File file) {
return new MavenContractsDownloader(mavenProject, one, "", "", StubRunnerProperties.StubsMode.LOCAL,
new SilentLog(), "", "", "", null, false, new HashMap<>(), false) {
@Override
ContractDownloader contractDownloader() {
return new ContractDownloader(null, null, null, null, null, null) {
int counterForDependencyOne;
@Override
public File unpackAndDownloadContracts() {
if (file == fileForDependencyOne) {
this.counterForDependencyOne = this.counterForDependencyOne + 1;
}
if (file == fileForDependencyOne && this.counterForDependencyOne == 2) {
throw new AssertionError("Second call for dependency 1 should come from cache");
}
return file;
}
@Override
public InclusionProperties createNewInclusionProperties(File contractsDirectory) {
return new InclusionPropertiesAccessor("a", "b");
}
};
}
};
}
private Dependency dependency(int number) {
Dependency dependency = new Dependency();
dependency.setGroupId("a" + number);
dependency.setArtifactId("b" + number);
dependency.setVersion("c" + number);
dependency.setClassifier("d" + number);
return dependency;
}
}

25
spring-cloud-contract-tools/spring-cloud-contract-maven-plugin/src/test/java/org/springframework/cloud/contract/stubrunner/InclusionPropertiesAccessor.java Normal file
View File

@@ -0,0 +1,25 @@
/*
* Copyright 2013-2020 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.springframework.cloud.contract.stubrunner;
public class InclusionPropertiesAccessor extends ContractDownloader.InclusionProperties {
public InclusionPropertiesAccessor(String includedContracts, String includedRootFolderAntPattern) {
super(includedContracts, includedRootFolderAntPattern);
}
}