@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/api/utils/BridgeMetadataUtils.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

var imperative = require('@zowe/imperative');
var EBGConstants = require('../constants/EBGConstants.js');
var LocalRepositoryUtils = require('./LocalRepositoryUtils.js');
var fs = require('fs');
var child_process = require('child_process');
var file = require('../../utils/file.js');

/*
 * Copyright (c) 2026 Broadcom.  All Rights Reserved.  The term
 * "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 *
 * This software and all information contained therein is
 * confidential and proprietary and shall not be duplicated,
 * used, disclosed, or disseminated in any way except as
 * authorized by the applicable license agreement, without the
 * express written permission of Broadcom.  All authorized
 * reproductions must be marked with this language.
 *
 * EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
 * THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
 * SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
 * LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
 * FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT WILL BROADCOM
 * BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
 * DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
 * INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
 * INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
 * EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
 *
 */
class BridgeMetadataUtils {
    static GIT_BIN = "git";
    static GIT_MERGE_ARGS = [
        "config",
        "merge.ours.driver",
        "true",
    ];
    /**
     *
     * @param gitLocation
     * @param systemDir
     * @param subSystemDir
     * @param typeDir
     */
    static readBridgeMetadataFile(gitLocation, systemDir, subSystemDir, typeDir) {
        const bridgeMetadataPath = EBGConstants.EBGConstants.getBridgeMetadataFilePath(systemDir, subSystemDir, typeDir, gitLocation);
        if (!fs.existsSync(bridgeMetadataPath)) {
            throw new imperative.ImperativeError({
                msg: `${bridgeMetadataPath} does not contain a valid .bridge.json file.`,
            });
        }
        return LocalRepositoryUtils.LocalRepositoryUtils.readJSONFileAsObject(bridgeMetadataPath, EBGConstants.EBGConstants.BRIDGE_METATDATA_FILENAME);
    }
    static checkBfgSetupExists() {
        return fs.existsSync(EBGConstants.EBGConstants.GIT_BFG_SETUP_PATH);
    }
    static checkGitPrepushHookExists() {
        return fs.existsSync(EBGConstants.EBGConstants.GIT_PRE_PUSH_PATH);
    }
    static writeTokenToBfgSetup(token) {
        file.writeSecretToDisk(EBGConstants.EBGConstants.GIT_BFG_SETUP_PATH, token);
    }
    static writeGitPrepushHook(script) {
        file.writeExecutableToDisk(EBGConstants.EBGConstants.GIT_PRE_PUSH_PATH, script);
    }
    static configureMergeDriver() {
        return child_process.spawnSync(this.GIT_BIN, this.GIT_MERGE_ARGS, {
            encoding: "utf-8",
        });
    }
    static updateBridgeMetadataFile(gitLocation, systemDir, subSystemDir, typeDir, bridgeMetadata) {
        const bridgeMetadataPath = EBGConstants.EBGConstants.getBridgeMetadataFilePath(systemDir, subSystemDir, typeDir, gitLocation);
        if (fs.existsSync(bridgeMetadataPath)) {
            const json = JSON.stringify(bridgeMetadata, null, 2)
                .replace(/\r\n/gm, "\n")
                .replace(/\n/gm, "\r\n");
            file.writeToDisk(bridgeMetadataPath, json);
        }
    }
}

exports.BridgeMetadataUtils = BridgeMetadataUtils;