testsrunner/org.eclipse.cdt.testsrunner/src/org/eclipse/cdt/testsrunner/internal/ui/view/TestPathUtils.java

/*******************************************************************************
 * Copyright (c) 2011, 2012 Anton Gorenkov
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     Anton Gorenkov - initial API and implementation
 *******************************************************************************/
package org.eclipse.cdt.testsrunner.internal.ui.view;

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

import org.eclipse.cdt.testsrunner.model.ITestItem;

/**
 * The utilities collection to work with the test paths for items in test
 * hierarchy.
 */
public class TestPathUtils {

	/**
	 * The delimiter between parts of serialized test path. Should not be met in
	 * test paths names.
	 */
	private static final String TEST_PATH_PART_DELIMITER = "\n"; //$NON-NLS-1$

	/** The delimiter between parts of human readable test path. */
	private static final String TEST_PATH_DELIMITER = "."; //$NON-NLS-1$

	/**
	 * Returns the human readable path to the item in test hierarchy (e.g.
	 * MySuite.MyInnerSuite.MyTest1).
	 *
	 * @param testItem test item (test suite or test case)
	 *
	 * @return path to test item
	 */
	public static String getTestItemPath(ITestItem testItem) {
		StringBuilder itemPath = new StringBuilder();
		List<ITestItem> parentItems = new ArrayList<>();
		while (testItem != null) {
			parentItems.add(testItem);
			testItem = testItem.getParent();
		}
		if (!parentItems.isEmpty()) {
			for (int i = parentItems.size() - 2/* exclude unnamed root test suite */; i >= 0; --i) {
				itemPath.append(parentItems.get(i).getName());
				if (i != 0) {
					itemPath.append(TEST_PATH_DELIMITER);
				}
			}
		}
		return itemPath.toString();
	}

	/**
	 * Unpack the paths from the string list.
	 *
	 * @param testPaths packed test paths
	 * @return array of test paths
	 *
	 * @see packTestPaths()
	 */
	public static String[][] unpackTestPaths(String[] testPaths) {
		String[][] result = new String[testPaths.length][];
		for (int i = 0; i < result.length; i++) {
			result[i] = testPaths[i].split(TEST_PATH_PART_DELIMITER);
		}
		return result;
	}

	/**
	 * Pack the paths to specified test items to string list.
	 *
	 * @param testItems test items to pack
	 * @return string list
	 *
	 * @see unpackTestPaths()
	 */
	public static String[] packTestPaths(ITestItem[] testItems) {
		String[] result = new String[testItems.length];
		List<String> testPath = new ArrayList<>();

		for (int itemIdx = 0; itemIdx < testItems.length; itemIdx++) {
			// Collect test path parts (in reverse order)
			testPath.clear();
			ITestItem item = testItems[itemIdx];
			while (item != null) {
				// Exclude root test suite
				if (item.getParent() != null) {
					testPath.add(item.getName());
				}
				item = item.getParent();
			}
			// Join path parts into the only string
			StringBuilder sb = new StringBuilder();
			boolean needDelimiter = false;
			for (int pathPartIdx = testPath.size() - 1; pathPartIdx >= 0; pathPartIdx--) {
				if (needDelimiter) {
					sb.append(TEST_PATH_PART_DELIMITER);
				} else {
					needDelimiter = true;
				}
				sb.append(testPath.get(pathPartIdx));
			}
			result[itemIdx] = sb.toString();
		}
		return result;
	}

}