137f5ec36d77b788239f20999fc57961e8c6c8f7
[teamcity/git-plugin.git] / git-agent / src / jetbrains / buildServer / buildTriggers / vcs / git / agent / UpdaterWithMirror.java
1 /*
2  * Copyright 2000-2014 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package jetbrains.buildServer.buildTriggers.vcs.git.agent;
18
19 import com.intellij.openapi.util.io.FileUtil;
20 import jetbrains.buildServer.agent.AgentRunningBuild;
21 import jetbrains.buildServer.agent.SmartDirectoryCleaner;
22 import jetbrains.buildServer.buildTriggers.vcs.git.GitUtils;
23 import jetbrains.buildServer.buildTriggers.vcs.git.MirrorManager;
24 import jetbrains.buildServer.buildTriggers.vcs.git.agent.errors.GitExecTimeout;
25 import jetbrains.buildServer.vcs.CheckoutRules;
26 import jetbrains.buildServer.vcs.VcsException;
27 import jetbrains.buildServer.vcs.VcsRoot;
28 import org.apache.log4j.Logger;
29 import org.eclipse.jgit.lib.Ref;
30 import org.eclipse.jgit.lib.Repository;
31 import org.eclipse.jgit.lib.RepositoryBuilder;
32 import org.eclipse.jgit.transport.URIish;
33 import org.jetbrains.annotations.NotNull;
34
35 import java.io.File;
36 import java.io.IOException;
37 import java.net.URISyntaxException;
38 import java.util.Map;
39
40 /**
41  * @author dmitry.neverov
42  */
43 public class UpdaterWithMirror extends UpdaterImpl {
44
45   private final static Logger LOG = Logger.getLogger(UpdaterWithMirror.class);
46
47   public UpdaterWithMirror(@NotNull FS fs,
48                            @NotNull AgentPluginConfig pluginConfig,
49                            @NotNull MirrorManager mirrorManager,
50                            @NotNull SmartDirectoryCleaner directoryCleaner,
51                            @NotNull GitFactory gitFactory,
52                            @NotNull AgentRunningBuild build,
53                            @NotNull VcsRoot root,
54                            @NotNull String version,
55                            @NotNull File targetDir,
56                            @NotNull CheckoutRules rules,
57                            @NotNull CheckoutMode mode) throws VcsException {
58     super(fs, pluginConfig, mirrorManager, directoryCleaner, gitFactory, build, root, version, targetDir, rules, mode);
59   }
60
61   @Override
62   protected void doUpdate() throws VcsException {
63     updateLocalMirror();
64     super.doUpdate();
65   }
66
67   private void updateLocalMirror() throws VcsException {
68     String message = "Update git mirror (" + myRoot.getRepositoryDir() + ")";
69     myLogger.activityStarted(message, GitBuildProgressLogger.GIT_PROGRESS_ACTIVITY);
70     try {
71       updateLocalMirror(true);
72       //prepare refs for copying into working dir repository
73       myGitFactory.create(myRoot.getRepositoryDir()).packRefs().call();
74     } finally {
75       myLogger.activityFinished(message, GitBuildProgressLogger.GIT_PROGRESS_ACTIVITY);
76     }
77   }
78
79   private void updateLocalMirror(boolean repeatFetchAttempt) throws VcsException {
80     File bareRepositoryDir = myRoot.getRepositoryDir();
81     String mirrorDescription = "local mirror of root " + myRoot.getName() + " at " + bareRepositoryDir;
82     LOG.info("Update " + mirrorDescription);
83     boolean fetchRequired = true;
84     if (isValidGitRepo(bareRepositoryDir)) {
85       removeOrphanedIdxFiles(bareRepositoryDir);
86     } else {
87       FileUtil.delete(bareRepositoryDir);
88     }
89     boolean newMirror = false;
90     if (!bareRepositoryDir.exists()) {
91       LOG.info("Init " + mirrorDescription);
92       bareRepositoryDir.mkdirs();
93       GitFacade git = myGitFactory.create(bareRepositoryDir);
94       git.init().setBare(true).call();
95       configureRemoteUrl(bareRepositoryDir);
96       newMirror = true;
97     } else {
98       configureRemoteUrl(bareRepositoryDir);
99       boolean outdatedTagsFound = removeOutdatedRefs(bareRepositoryDir);
100       if (!outdatedTagsFound) {
101         LOG.debug("Try to find revision " + myRevision + " in " + mirrorDescription);
102         Ref ref = getRef(bareRepositoryDir, GitUtils.createRemoteRef(myFullBranchName));
103         if (ref != null && myRevision.equals(ref.getObjectId().name())) {
104           LOG.info("No fetch required for revision '" + myRevision + "' in " + mirrorDescription);
105           fetchRequired = false;
106         }
107       }
108     }
109     Ref ref = getRef(bareRepositoryDir, myFullBranchName);
110     if (ref == null)
111       fetchRequired = true;
112     if (!fetchRequired && !myPluginConfig.isFetchAllHeads())
113       return;
114     if (!newMirror && optimizeMirrorBeforeFetch()) {
115       GitFacade git = myGitFactory.create(bareRepositoryDir);
116       git.gc().call();
117       git.repack().call();
118     }
119     if (myPluginConfig.isFetchAllHeads()) {
120       String msg = getForcedHeadsFetchMessage();
121       LOG.info(msg);
122       myLogger.message(msg);
123
124       fetchMirror(repeatFetchAttempt, bareRepositoryDir, "+refs/heads/*:refs/heads/*", false);
125     } else {
126       fetchMirror(repeatFetchAttempt, bareRepositoryDir, "+" + myFullBranchName + ":" + GitUtils.expandRef(myFullBranchName), false);
127       if (hasRevision(bareRepositoryDir, myRevision))
128         return;
129       fetchMirror(repeatFetchAttempt, bareRepositoryDir, "+refs/heads/*:refs/heads/*", false);
130     }
131   }
132
133
134   private boolean optimizeMirrorBeforeFetch() {
135     return "true".equals(myBuild.getSharedConfigParameters().get("teamcity.git.optimizeMirrorBeforeFetch"));
136   }
137
138
139   private void fetchMirror(boolean repeatFetchAttempt,
140                            @NotNull File repositoryDir,
141                            @NotNull String refspec,
142                            boolean shallowClone) throws VcsException {
143     removeRefLocks(repositoryDir);
144     try {
145       fetch(repositoryDir, refspec, shallowClone);
146     } catch (VcsException e) {
147       if (myPluginConfig.isFailOnCleanCheckout() || !repeatFetchAttempt || !shouldFetchFromScratch(e))
148         throw e;
149       if (cleanDir(repositoryDir)) {
150         GitFacade git = myGitFactory.create(repositoryDir);
151         git.init().setBare(true).call();
152         configureRemoteUrl(repositoryDir);
153         fetch(repositoryDir, refspec, shallowClone);
154       } else {
155         LOG.info("Failed to delete repository " + repositoryDir + " after failed checkout, clone repository in another directory");
156         myMirrorManager.invalidate(repositoryDir);
157         updateLocalMirror(false);
158       }
159     }
160   }
161
162
163   private boolean shouldFetchFromScratch(@NotNull VcsException e) {
164     if (e instanceof GitExecTimeout)
165       return false;
166     String msg = e.getMessage();
167     if (msg.contains("Couldn't find remote ref") ||
168         msg.contains("Could not read from remote repository")) {
169       return false;
170     }
171     return true;
172   }
173
174
175   private boolean cleanDir(final @NotNull File repositoryDir) {
176     return myFS.delete(repositoryDir) && myFS.mkdirs(repositoryDir);
177   }
178
179
180   private boolean isValidGitRepo(@NotNull File gitDir) {
181     try {
182       new RepositoryBuilder().setGitDir(gitDir).setMustExist(true).build();
183       return true;
184     } catch (IOException e) {
185       return false;
186     }
187   }
188
189
190   @Override
191   protected void setupExistingRepository() throws VcsException {
192     removeUrlSections();
193     setUseLocalMirror();
194     disableAlternates();
195   }
196
197   @Override
198   protected void setupNewRepository() throws VcsException {
199     setUseLocalMirror();
200     disableAlternates();
201   }
202
203   @Override
204   protected void ensureCommitLoaded(boolean fetchRequired) throws VcsException {
205     if (myPluginConfig.isUseShallowClone()) {
206       File mirrorRepositoryDir = myRoot.getRepositoryDir();
207       if (GitUtils.isTag(myFullBranchName)) {
208         //handle tags specially: if we fetch a temporary branch which points to a commit
209         //tags points to, git fetches both branch and tag, tries to make a local
210         //branch to track both of them and fails.
211         String refspec = "+" + myFullBranchName + ":" + myFullBranchName;
212         fetch(myTargetDirectory, refspec, true);
213       } else {
214         String tmpBranchName = createTmpBranch(mirrorRepositoryDir, myRevision);
215         String tmpBranchRef = "refs/heads/" + tmpBranchName;
216         String refspec = "+" + tmpBranchRef + ":" + GitUtils.createRemoteRef(myFullBranchName);
217         fetch(myTargetDirectory, refspec, true);
218         myGitFactory.create(mirrorRepositoryDir).deleteBranch().setName(tmpBranchName).call();
219       }
220     } else {
221       super.ensureCommitLoaded(fetchRequired);
222     }
223   }
224
225
226   @NotNull
227   private String readRemoteUrl() throws VcsException {
228     Repository repository = null;
229     try {
230       repository = new RepositoryBuilder().setWorkTree(myTargetDirectory).build();
231       return repository.getConfig().getString("remote", "origin", "url");
232     } catch (IOException e) {
233       throw new VcsException("Error while reading remote repository url", e);
234     } finally {
235       if (repository != null)
236         repository.close();
237     }
238   }
239
240
241   private void setUseLocalMirror() throws VcsException {
242     //read remote url from config instead of VCS root, they can be different
243     //e.g. due to username exclusion from http(s) urls
244     String remoteUrl = readRemoteUrl();
245     String localMirrorUrl = getLocalMirrorUrl();
246     GitFacade git = myGitFactory.create(myTargetDirectory);
247     git.setConfig()
248       .setPropertyName("url." + localMirrorUrl + ".insteadOf")
249       .setValue(remoteUrl)
250       .call();
251     git.setConfig()
252       .setPropertyName("url." + remoteUrl + ".pushInsteadOf")
253       .setValue(remoteUrl)
254       .call();
255   }
256
257   private String getLocalMirrorUrl() throws VcsException {
258     try {
259       return new URIish(myRoot.getRepositoryDir().toURI().toASCIIString()).toString();
260     } catch (URISyntaxException e) {
261       throw new VcsException("Cannot create uri for local mirror " + myRoot.getRepositoryDir().getAbsolutePath(), e);
262     }
263   }
264
265   private String createTmpBranch(@NotNull File repositoryDir, @NotNull String branchStartingPoint) throws VcsException {
266     String tmpBranchName = getUnusedBranchName(repositoryDir);
267     myGitFactory.create(repositoryDir)
268       .createBranch()
269       .setName(tmpBranchName)
270       .setStartPoint(branchStartingPoint)
271       .call();
272     return tmpBranchName;
273   }
274
275   private String getUnusedBranchName(@NotNull File repositoryDir) {
276     final String tmpBranchName = "tmp_branch_for_build";
277     String branchName = tmpBranchName;
278     Map<String, Ref> existingRefs = myGitFactory.create(repositoryDir).showRef().call().getValidRefs();
279     int i = 0;
280     while (existingRefs.containsKey("refs/heads/" + branchName)) {
281       branchName = tmpBranchName + i;
282       i++;
283     }
284     return branchName;
285   }
286 }