View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.shared.release.scm;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  import javax.inject.Singleton;
24  
25  import java.util.concurrent.atomic.AtomicReference;
26  
27  import org.apache.maven.scm.manager.NoSuchScmProviderException;
28  import org.apache.maven.scm.manager.ScmManager;
29  import org.apache.maven.scm.provider.ScmProvider;
30  import org.apache.maven.scm.provider.ScmProviderRepository;
31  import org.apache.maven.scm.provider.ScmProviderRepositoryWithHost;
32  import org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;
33  import org.apache.maven.scm.repository.ScmRepository;
34  import org.apache.maven.scm.repository.ScmRepositoryException;
35  import org.apache.maven.settings.Server;
36  import org.apache.maven.settings.Settings;
37  import org.apache.maven.shared.release.config.ReleaseDescriptor;
38  import org.apache.maven.shared.release.util.MavenCrypto;
39  import org.apache.maven.shared.release.util.MavenCrypto.MavenCryptoException;
40  import org.slf4j.Logger;
41  import org.slf4j.LoggerFactory;
42  
43  import static java.util.Objects.requireNonNull;
44  
45  /**
46   * Tool that gets a configured SCM repository from release configuration.
47   *
48   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
49   */
50  @Singleton
51  @Named
52  public class DefaultScmRepositoryConfigurator implements ScmRepositoryConfigurator {
53      private final Logger logger = LoggerFactory.getLogger(getClass());
54  
55      private final AtomicReference<ScmManager> scmManager;
56  
57      private final MavenCrypto mavenCrypto;
58  
59      @Inject
60      public DefaultScmRepositoryConfigurator(ScmManager scmManager, MavenCrypto mavenCrypto) {
61          this.scmManager = new AtomicReference<>(requireNonNull(scmManager));
62          this.mavenCrypto = requireNonNull(mavenCrypto);
63      }
64  
65      /**
66       * For testing purposes only!
67       */
68      public void setScmManager(ScmManager scmManager) {
69          this.scmManager.set(scmManager);
70      }
71  
72      @Override
73      public ScmRepository getConfiguredRepository(ReleaseDescriptor releaseDescriptor, Settings settings)
74              throws ScmRepositoryException, NoSuchScmProviderException {
75          String url = releaseDescriptor.getScmSourceUrl();
76          return getConfiguredRepository(url, releaseDescriptor, settings);
77      }
78  
79      @Override
80      public ScmRepository getConfiguredRepository(String url, ReleaseDescriptor releaseDescriptor, Settings settings)
81              throws ScmRepositoryException, NoSuchScmProviderException {
82          String username = releaseDescriptor.getScmUsername();
83          String password = releaseDescriptor.getScmPassword();
84          String privateKey = releaseDescriptor.getScmPrivateKey();
85          String passphrase = releaseDescriptor.getScmPrivateKeyPassPhrase();
86  
87          ScmRepository repository = scmManager.get().makeScmRepository(url);
88  
89          ScmProviderRepository scmRepo = repository.getProviderRepository();
90  
91          // MRELEASE-76
92          scmRepo.setPersistCheckout(false);
93          scmRepo.setPushChanges(releaseDescriptor.isPushChanges());
94  
95          if (settings != null) {
96              Server server = null;
97  
98              if (releaseDescriptor.getScmId() != null) {
99                  server = settings.getServer(releaseDescriptor.getScmId());
100                 if (server == null) {
101                     logger.warn("No server with id '{}' found in Maven settings", releaseDescriptor.getScmId());
102                 }
103             }
104 
105             if (server == null && repository.getProviderRepository() instanceof ScmProviderRepositoryWithHost) {
106                 ScmProviderRepositoryWithHost repositoryWithHost =
107                         (ScmProviderRepositoryWithHost) repository.getProviderRepository();
108                 String host = repositoryWithHost.getHost();
109 
110                 int port = repositoryWithHost.getPort();
111 
112                 if (port > 0) {
113                     host += ":" + port;
114                 }
115 
116                 // TODO: this is a bit dodgy - id is not host, but since we don't have a <host> field we make an
117                 // assumption
118                 server = settings.getServer(host);
119             }
120 
121             if (server != null) {
122                 if (username == null && server.getUsername() != null) {
123                     logger.debug(
124                             "Using username from server id '{}' found in Maven settings", releaseDescriptor.getScmId());
125                     username = server.getUsername();
126                 }
127 
128                 if (password == null && server.getPassword() != null) {
129                     logger.debug(
130                             "Using password from server id '{}' found in Maven settings", releaseDescriptor.getScmId());
131                     password = decrypt(server.getPassword(), server.getId());
132                 }
133 
134                 if (privateKey == null && server.getPrivateKey() != null) {
135                     logger.debug(
136                             "Using private key from server id '{}' found in Maven settings",
137                             releaseDescriptor.getScmId());
138                     privateKey = server.getPrivateKey();
139                 }
140 
141                 if (passphrase == null && server.getPassphrase() != null) {
142                     logger.debug(
143                             "Using passphrase from server id '{}' found in Maven settings",
144                             releaseDescriptor.getScmId());
145                     passphrase = decrypt(server.getPassphrase(), server.getId());
146                 }
147             }
148         }
149 
150         if (!(username == null || username.isEmpty())) {
151             scmRepo.setUser(username);
152         } else {
153             logger.debug("No explicit username configured");
154         }
155         if (!(password == null || password.isEmpty())) {
156             scmRepo.setPassword(password);
157         } else {
158             logger.debug("No explicit password configured");
159         }
160 
161         if (scmRepo instanceof ScmProviderRepositoryWithHost) {
162             ScmProviderRepositoryWithHost repositoryWithHost = (ScmProviderRepositoryWithHost) scmRepo;
163             if (!(privateKey == null || privateKey.isEmpty())) {
164                 repositoryWithHost.setPrivateKey(privateKey);
165             } else {
166                 logger.debug("No explicit private key configured");
167             }
168 
169             if (!(passphrase == null || passphrase.isEmpty())) {
170                 repositoryWithHost.setPassphrase(passphrase);
171             } else {
172                 logger.debug("No explicit passphrase configured");
173             }
174         }
175 
176         if ("svn".equals(repository.getProvider())) {
177             SvnScmProviderRepository svnRepo = (SvnScmProviderRepository) repository.getProviderRepository();
178 
179             String tagBase = releaseDescriptor.getScmTagBase();
180             if (!(tagBase == null || tagBase.isEmpty())) {
181                 svnRepo.setTagBase(tagBase);
182             }
183 
184             String branchBase = releaseDescriptor.getScmBranchBase();
185             if (!(branchBase == null || branchBase.isEmpty())) {
186                 svnRepo.setBranchBase(branchBase);
187             }
188         }
189         if (!releaseDescriptor.isInteractive()) {
190             scmManager.get().getProviderByRepository(repository).setInteractive(releaseDescriptor.isInteractive());
191         }
192         return repository;
193     }
194 
195     private String decrypt(String str, String serverId) {
196         try {
197             return mavenCrypto.decrypt(str);
198         } catch (MavenCryptoException e) {
199             String msg = "Failed to decrypt password/passphrase for server with id '" + serverId
200                     + "', using auth token as is: " + e.getMessage();
201             if (logger.isDebugEnabled()) {
202                 logger.warn(msg, e);
203             } else {
204                 logger.warn(msg);
205             }
206             return str;
207         }
208     }
209 
210     @Override
211     public ScmProvider getRepositoryProvider(ScmRepository repository) throws NoSuchScmProviderException {
212         return scmManager.get().getProviderByRepository(repository);
213     }
214 }