com.microsoft.alm.plugin.external.commands.FindWorkspaceCommand.java Source code

Introduction

Here is the source code for com.microsoft.alm.plugin.external.commands.FindWorkspaceCommand.java

Source

// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See License.txt in the project root.

package com.microsoft.alm.plugin.external.commands;

import com.microsoft.alm.common.utils.ArgumentHelper;
import com.microsoft.alm.plugin.external.ToolRunner;
import com.microsoft.alm.plugin.external.models.Workspace;
import org.apache.commons.lang.StringUtils;

import java.util.ArrayList;
import java.util.List;

/**
 * This command only returns a partial workspace object that allows you to get the name and server.
 * To get the entire workspace object you should call GetWorkspace with the workspace name.
 * (This is one of the only commands that expects to be a strictly local operation - no server calls - and so does not
 * take a server context object in the constructor)
 */
public class FindWorkspaceCommand extends Command<Workspace> {
    private final String localPath;

    public FindWorkspaceCommand(final String localPath) {
        super("workfold", null);
        ArgumentHelper.checkNotEmptyString(localPath, "localPath");
        this.localPath = localPath;
    }

    @Override
    public ToolRunner.ArgumentBuilder getArgumentBuilder() {
        final ToolRunner.ArgumentBuilder builder = super.getArgumentBuilder();
        // To find the workspace we set the working directory to the localPath and call workfold with no arguments
        // NOTE Calling workfold with the localPath forces it to refresh the workspace from the server. Calling it with
        //      no arguments does not refresh it from the server.
        builder.setWorkingDirectory(localPath);
        return builder;
    }

    /**
     * Parses the output of the workfold command. (NOT XML)
     * SAMPLE
     * =====================================================================================================================================================
     * Workspace:  MyNewWorkspace2
     * Collection: http://java-tfs2015:8081/tfs/
     * $/tfsTest_01: D:\tmp\test
     */
    @Override
    public Workspace parseOutput(final String stdout, final String stderr) {
        super.throwIfError(stderr);

        // look for the ==== line to see if the command was successful
        final String[] lines = getLines(stdout);
        if (lines.length > 2 && lines[0].contains("==========")) {
            // Get the name and url from the next 2 lines
            final String workspaceName = getValue(lines[1]);
            final String collectionURL = getValue(lines[2]);
            // Finally, parse the workspace mappings
            final List<Workspace.Mapping> mappings = new ArrayList<Workspace.Mapping>(10);
            for (int i = 3; i < lines.length; i++) {
                Workspace.Mapping mapping = getMapping(lines[i]);
                if (mapping != null) {
                    mappings.add(mapping);
                }
            }
            return new Workspace(collectionURL, workspaceName, "", "", "", mappings);
        }

        return null;
    }

    /**
     * This method parses a single line of output splitting on ": " and returning the value after the colon
     * Example:  "   Name: myWorkspace"  => "myWorkspace"
     */
    private String getValue(final String line) {
        final int index = line.indexOf(": ");
        return line.substring(index + 2).trim();
    }

    /**
     * This method parses a single line of output returning the mapping if one was found
     * Examples:
     * "$/TFVC_11/folder1: D:\tmp\notdefault\folder1"
     * "(cloaked) $/TFVC_11/folder1:"
     */
    private Workspace.Mapping getMapping(final String line) {
        final boolean isCloaked = StringUtils.startsWithIgnoreCase(line.trim(), "(cloaked)");
        final int endIndex = line.indexOf(":");
        final int startIndex = isCloaked ? line.indexOf(")") + 1 : 0;
        if (endIndex >= 0) {
            final String serverPath = line.substring(startIndex, endIndex).trim();
            final String localPath = line.substring(endIndex + 1).trim();
            return new Workspace.Mapping(serverPath, localPath, isCloaked);
        }

        return null;
    }
}