1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.springframework.cloud.contract.maven.verifier;
18
19 import java.io.File;
20 import java.util.Map;
21
22 import org.apache.maven.model.Dependency;
23 import org.apache.maven.plugin.logging.Log;
24 import org.apache.maven.project.MavenProject;
25
26 import org.springframework.cloud.contract.stubrunner.ContractDownloader;
27 import org.springframework.cloud.contract.stubrunner.StubConfiguration;
28 import org.springframework.cloud.contract.stubrunner.StubDownloader;
29 import org.springframework.cloud.contract.stubrunner.StubDownloaderBuilderProvider;
30 import org.springframework.cloud.contract.stubrunner.StubRunnerOptions;
31 import org.springframework.cloud.contract.stubrunner.StubRunnerOptionsBuilder;
32 import org.springframework.cloud.contract.stubrunner.spring.StubRunnerProperties;
33 import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties;
34 import org.springframework.util.StringUtils;
35
36
37
38
39
40
41
42 class MavenContractsDownloader {
43
44 private static final String LATEST_VERSION = "+";
45
46 private static final String CONTRACTS_DIRECTORY_PROP = "CONTRACTS_DIRECTORY";
47
48 private final MavenProject project;
49
50 private final Dependency contractDependency;
51
52 private final String contractsPath;
53
54 private final String contractsRepositoryUrl;
55
56 private final StubRunnerProperties.StubsMode stubsMode;
57
58 private final Log log;
59
60 private final StubDownloaderBuilderProvider stubDownloaderBuilderProvider;
61
62 private final String repositoryUsername;
63
64 private final String repositoryPassword;
65
66 private final String repositoryProxyHost;
67
68 private final Integer repositoryProxyPort;
69
70 private final boolean deleteStubsAfterTest;
71
72 private final Map<String, String> contractsProperties;
73
74 private final boolean failOnNoStubs;
75
76 MavenContractsDownloader(MavenProject project, Dependency contractDependency, String contractsPath,
77 String contractsRepositoryUrl, StubRunnerProperties.StubsMode stubsMode, Log log, String repositoryUsername,
78 String repositoryPassword, String repositoryProxyHost, Integer repositoryProxyPort,
79 boolean deleteStubsAfterTest, Map<String, String> contractsProperties, boolean failOnNoContracts) {
80 this.project = project;
81 this.contractDependency = contractDependency;
82 this.contractsPath = contractsPath;
83 this.contractsRepositoryUrl = contractsRepositoryUrl;
84 this.stubsMode = stubsMode;
85 this.log = log;
86 this.repositoryUsername = repositoryUsername;
87 this.repositoryPassword = repositoryPassword;
88 this.repositoryProxyHost = repositoryProxyHost;
89 this.repositoryProxyPort = repositoryProxyPort;
90 this.stubDownloaderBuilderProvider = new StubDownloaderBuilderProvider();
91 this.deleteStubsAfterTest = deleteStubsAfterTest;
92 this.contractsProperties = contractsProperties;
93 this.failOnNoStubs = failOnNoContracts;
94 }
95
96 File downloadAndUnpackContractsIfRequired(ContractVerifierConfigProperties config, File defaultContractsDir) {
97 String contractsDirFromProp = this.project.getProperties().getProperty(CONTRACTS_DIRECTORY_PROP);
98 File downloadedContractsDir = StringUtils.hasText(contractsDirFromProp) ? new File(contractsDirFromProp) : null;
99
100 if (downloadedContractsDir != null && downloadedContractsDir.exists()) {
101 this.log.info("Another mojo has downloaded the contracts - will reuse them from [" + downloadedContractsDir
102 + "]");
103 final ContractDownloader.InclusionProperties inclusionProperties = contractDownloader()
104 .createNewInclusionProperties(downloadedContractsDir);
105 config.setIncludedContracts(inclusionProperties.getIncludedContracts());
106 config.setIncludedRootFolderAntPattern(inclusionProperties.getIncludedRootFolderAntPattern());
107 return downloadedContractsDir;
108 }
109 else if (shouldDownloadContracts()) {
110 this.log.info("Download dependency is provided - will retrieve contracts from a remote location");
111 final ContractDownloader contractDownloader = contractDownloader();
112 final File downloadedContracts = contractDownloader.unpackAndDownloadContracts();
113 final ContractDownloader.InclusionProperties inclusionProperties = contractDownloader
114 .createNewInclusionProperties(downloadedContracts);
115 config.setIncludedContracts(inclusionProperties.getIncludedContracts());
116 config.setIncludedRootFolderAntPattern(inclusionProperties.getIncludedRootFolderAntPattern());
117 this.project.getProperties().setProperty(CONTRACTS_DIRECTORY_PROP, downloadedContracts.getAbsolutePath());
118 return downloadedContracts;
119 }
120 this.log.info("Will use contracts provided in the folder [" + defaultContractsDir + "]");
121 return defaultContractsDir;
122 }
123
124 private boolean shouldDownloadContracts() {
125 return this.contractDependency != null && StringUtils.hasText(this.contractDependency.getArtifactId())
126 || StringUtils.hasText(this.contractsRepositoryUrl);
127 }
128
129 private ContractDownloader contractDownloader() {
130 return new ContractDownloader(stubDownloader(), stubConfiguration(), this.contractsPath,
131 this.project.getGroupId(), this.project.getArtifactId(), this.project.getVersion());
132 }
133
134 private StubDownloader stubDownloader() {
135 StubRunnerOptions stubRunnerOptions = buildOptions();
136 return this.stubDownloaderBuilderProvider.get(stubRunnerOptions);
137 }
138
139 StubRunnerOptions buildOptions() {
140 StubRunnerOptionsBuilder builder = new StubRunnerOptionsBuilder()
141 .withOptions(StubRunnerOptions.fromSystemProps()).withStubsMode(this.stubsMode)
142 .withUsername(this.repositoryUsername).withPassword(this.repositoryPassword)
143 .withDeleteStubsAfterTest(this.deleteStubsAfterTest).withProperties(this.contractsProperties)
144 .withFailOnNoStubs(this.failOnNoStubs);
145 if (StringUtils.hasText(this.contractsRepositoryUrl)) {
146 builder.withStubRepositoryRoot(this.contractsRepositoryUrl);
147 }
148 if (this.repositoryProxyPort != null) {
149 builder.withProxy(this.repositoryProxyHost, this.repositoryProxyPort);
150 }
151 return builder.build();
152 }
153
154 private StubConfiguration stubConfiguration() {
155 String groupId = this.contractDependency.getGroupId();
156 String artifactId = this.contractDependency.getArtifactId();
157 String version = StringUtils.hasText(this.contractDependency.getVersion())
158 ? this.contractDependency.getVersion() : LATEST_VERSION;
159 String classifier = this.contractDependency.getClassifier();
160 return new StubConfiguration(groupId, artifactId, version, classifier);
161 }
162
163 }