LightPIT: src/main/kotlin/de/uapcore/lightpit/vcs/HgConnector.kt@12b898531d1a

     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  */

    27 package de.uapcore.lightpit.vcs

    29 import java.nio.file.Files

    30 import java.nio.file.Path

    31 import kotlin.io.path.ExperimentalPathApi

    32 import kotlin.io.path.deleteRecursively

    34 /**

    35  * A connector for Mercurial repositories.

    36  *

    37  * @param path the path to the Mercurial binary

    38  */

    39 class HgConnector(path: String) : VcsConnector(path) {

    41     /**

    42      * Checks, if the specified binary is available and executable.

    43      */

    44     fun checkAvailability(): Boolean {

    45         return when (val versionInfo = invokeCommand(Path.of("."), "--version")) {

    46             is VcsConnectorResult.Success -> versionInfo.content.contains("Mercurial")

    47             else -> false

    48         }

    49     }

    51     /**

    52      * Reads the commit log and parses every reference to an issue.

    53      *

    54      * The [pathOrUrl] must be a valid path or URL recognized by the VCS binary.

    55      * Currently, no authentication is supported and the repository must therefore be publicly readable.

    56      */

    57     @OptIn(ExperimentalPathApi::class)

    58     fun readCommitLog(pathOrUrl: String): VcsConnectorResult<List<CommitRef>> {

    59         val tmpDir = try {

    60             Files.createTempDirectory("lightpit-vcs-")

    61         } catch (e: Throwable) {

    62             return VcsConnectorResult.Error("Creating temporary directory for VCS connection failed: " + e.message)

    63         }

    64         val init = invokeCommand(tmpDir, "init")

    65         if (init is VcsConnectorResult.Error) {

    66             return init

    67         }

    69         val commitLogContent = when (val result = invokeCommand(

    70             tmpDir, "incoming", pathOrUrl, "-n", "--template", "::lpitref::{node}:{desc}\\n"

    71         )) {

    72             is VcsConnectorResult.Error -> return result

    73             is VcsConnectorResult.Success -> result.content

    74         }

    76         val commitRefs = parseCommitRefs(commitLogContent)

    78         tmpDir.deleteRecursively()

    79         return VcsConnectorResult.Success(commitRefs)

    80     }

    81 }

Mercurial > hg > LightPIT / file revision