1 /* |
|
2 * Copyright 2023 Mike Becker. All rights reserved. |
|
3 * |
|
4 * Redistribution and use in source and binary forms, with or without |
|
5 * modification, are permitted provided that the following conditions are met: |
|
6 * |
|
7 * 1. Redistributions of source code must retain the above copyright |
|
8 * notice, this list of conditions and the following disclaimer. |
|
9 * |
|
10 * 2. Redistributions in binary form must reproduce the above copyright |
|
11 * notice, this list of conditions and the following disclaimer in the |
|
12 * documentation and/or other materials provided with the distribution. |
|
13 * |
|
14 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
|
15 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
|
17 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
|
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
|
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
|
20 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
|
21 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
|
22 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
24 * |
|
25 */ |
|
26 |
|
27 package de.uapcore.lightpit.vcs |
|
28 |
|
29 import java.nio.file.Files |
|
30 import kotlin.io.path.ExperimentalPathApi |
|
31 import kotlin.io.path.deleteRecursively |
|
32 |
|
33 /** |
|
34 * A connector for Mercurial repositories. |
|
35 * |
|
36 * @param path the path to the Mercurial binary |
|
37 */ |
|
38 class HgConnector(path: String) : VcsConnector(path) { |
|
39 |
|
40 /** |
|
41 * Checks, if the specified binary is available and executable. |
|
42 */ |
|
43 fun checkAvailability(): Boolean { |
|
44 return when (val versionInfo = invokeCommand("--version")) { |
|
45 is VcsConnectorResult.Success -> versionInfo.content.contains("Mercurial") |
|
46 else -> false |
|
47 } |
|
48 } |
|
49 |
|
50 /** |
|
51 * Reads the commit log and parses every reference to an issue. |
|
52 * |
|
53 * The [pathOrUrl] must be a valid path or URL recognized by the VCS binary. |
|
54 * Currently, no authentication is supported and the repository must therefore be publicly readable. |
|
55 */ |
|
56 @OptIn(ExperimentalPathApi::class) |
|
57 fun readCommitLog(pathOrUrl: String): VcsConnectorResult<List<CommitRef>> { |
|
58 val tmpDir = try { |
|
59 Files.createTempDirectory("lightpit-vcs-") |
|
60 } catch (e: Throwable) { |
|
61 return VcsConnectorResult.Error("Creating temporary directory for VCS connection failed: " + e.message) |
|
62 } |
|
63 val init = invokeCommand("init", workingDir = tmpDir) |
|
64 if (init is VcsConnectorResult.Error) { |
|
65 return init |
|
66 } |
|
67 |
|
68 val commitLogContent = when (val result = invokeCommand( |
|
69 "incoming", pathOrUrl, "-n", "--template", "::lpitref::{node}:{desc}\\n", |
|
70 workingDir = tmpDir, |
|
71 timeout = 60 |
|
72 )) { |
|
73 is VcsConnectorResult.Error -> return result |
|
74 is VcsConnectorResult.Success -> result.content |
|
75 } |
|
76 |
|
77 val commitRefs = parseCommitRefs(commitLogContent) |
|
78 |
|
79 tmpDir.deleteRecursively() |
|
80 return VcsConnectorResult.Success(commitRefs) |
|
81 } |
|
82 } |
|