diff options
Diffstat (limited to 'plugins/org.eclipse.osee.define/src/org/eclipse/osee/define/traceability/blam/UiToTestBlam.java')
| -rw-r--r-- | plugins/org.eclipse.osee.define/src/org/eclipse/osee/define/traceability/blam/UiToTestBlam.java | 460 |
1 files changed, 230 insertions, 230 deletions
diff --git a/plugins/org.eclipse.osee.define/src/org/eclipse/osee/define/traceability/blam/UiToTestBlam.java b/plugins/org.eclipse.osee.define/src/org/eclipse/osee/define/traceability/blam/UiToTestBlam.java index 634eb05ea9c..f5f82ecaf12 100644 --- a/plugins/org.eclipse.osee.define/src/org/eclipse/osee/define/traceability/blam/UiToTestBlam.java +++ b/plugins/org.eclipse.osee.define/src/org/eclipse/osee/define/traceability/blam/UiToTestBlam.java @@ -1,233 +1,233 @@ -/*******************************************************************************
- * Copyright (c) 2004, 2007 Boeing.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
- *
- * Contributors:
- * Boeing - initial API and implementation
- *******************************************************************************/
-package org.eclipse.osee.define.traceability.blam;
-
+/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.define.traceability.blam; + import static org.eclipse.osee.framework.skynet.core.artifact.DeletionFlag.EXCLUDE_DELETED; -import java.io.BufferedInputStream;
-import java.io.File;
-import java.io.InputStream;
-import java.io.StringWriter;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
-import org.eclipse.core.filesystem.EFS;
-import org.eclipse.core.filesystem.IFileStore;
-import org.eclipse.core.resources.IFile;
-import org.eclipse.core.runtime.IProgressMonitor;
-import org.eclipse.osee.define.traceability.data.RequirementData;
-import org.eclipse.osee.framework.core.enums.CoreRelationTypes;
-import org.eclipse.osee.framework.core.enums.IRelationEnumeration;
-import org.eclipse.osee.framework.core.exception.OseeArgumentException;
-import org.eclipse.osee.framework.core.exception.OseeCoreException;
-import org.eclipse.osee.framework.core.exception.OseeExceptions;
-import org.eclipse.osee.framework.core.model.Branch;
-import org.eclipse.osee.framework.jdk.core.util.Lib;
-import org.eclipse.osee.framework.jdk.core.util.Strings;
-import org.eclipse.osee.framework.plugin.core.util.AIFile;
-import org.eclipse.osee.framework.plugin.core.util.OseeData;
-import org.eclipse.osee.framework.skynet.core.artifact.Artifact;
-import org.eclipse.osee.framework.skynet.core.artifact.search.ArtifactQuery;
-import org.eclipse.osee.framework.ui.skynet.blam.AbstractBlam;
-import org.eclipse.osee.framework.ui.skynet.blam.VariableMap;
-import org.eclipse.osee.framework.ui.skynet.results.XResultData;
-import org.eclipse.swt.program.Program;
-
-/**
- * @author Roberto E. Escobar
- */
-public class UiToTestBlam extends AbstractBlam {
- private static final String EMPTY_STRING = "";
-
- @Override
- public String getName() {
- return "UI To Test Report";
- }
-
- @Override
- public Collection<String> getCategories() {
- return Arrays.asList("Define.Trace");
- }
-
- @Override
- public String getDescriptionUsage() {
- return "Usage Info here";
- }
-
- @Override
- public String getXWidgetsXml() {
- StringBuilder builder = new StringBuilder();
- builder.append("<xWidgets>");
- builder.append("<XWidget xwidgetType=\"XFileSelectionDialog\" displayName=\"Select UI List File\" />");
- builder.append("<XWidget xwidgetType=\"XBranchSelectWidget\" displayName=\"Requirements Branch\" />");
- builder.append("</xWidgets>");
- return builder.toString();
- }
-
- @Override
- public void runOperation(VariableMap variableMap, IProgressMonitor monitor) throws Exception {
- String fileName = variableMap.getString("Select UI List File");
- Branch branch = variableMap.getBranch("Requirements Branch");
-
- if (branch == null) {
- throw new OseeArgumentException("Branch cannot be null");
- }
-
- XResultData resultData = new XResultData();
- resultData.log("UI To Test Traceability");
-
- Set<Artifact> toTrace = new HashSet<Artifact>();
- String input = null;
-
- monitor.beginTask("UI To Test Trace Report", IProgressMonitor.UNKNOWN);
- try {
- monitor.subTask("Gathering Requirements");
- if (Strings.isValid(fileName)) {
- input = getUIsFromFile(monitor, fileName);
- }
-
- if (Strings.isValid(input)) {
- for (String ui : input.split("\n")) {
- String toGet = ui.trim();
+import java.io.BufferedInputStream; +import java.io.File; +import java.io.InputStream; +import java.io.StringWriter; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.HashSet; +import java.util.List; +import java.util.Set; +import org.eclipse.core.filesystem.EFS; +import org.eclipse.core.filesystem.IFileStore; +import org.eclipse.core.resources.IFile; +import org.eclipse.core.runtime.IProgressMonitor; +import org.eclipse.osee.define.traceability.data.RequirementData; +import org.eclipse.osee.framework.core.enums.CoreRelationTypes; +import org.eclipse.osee.framework.core.enums.IRelationEnumeration; +import org.eclipse.osee.framework.core.exception.OseeArgumentException; +import org.eclipse.osee.framework.core.exception.OseeCoreException; +import org.eclipse.osee.framework.core.exception.OseeExceptions; +import org.eclipse.osee.framework.core.model.Branch; +import org.eclipse.osee.framework.jdk.core.util.Lib; +import org.eclipse.osee.framework.jdk.core.util.Strings; +import org.eclipse.osee.framework.plugin.core.util.AIFile; +import org.eclipse.osee.framework.plugin.core.util.OseeData; +import org.eclipse.osee.framework.skynet.core.artifact.Artifact; +import org.eclipse.osee.framework.skynet.core.artifact.search.ArtifactQuery; +import org.eclipse.osee.framework.ui.skynet.blam.AbstractBlam; +import org.eclipse.osee.framework.ui.skynet.blam.VariableMap; +import org.eclipse.osee.framework.ui.skynet.results.XResultData; +import org.eclipse.swt.program.Program; + +/** + * @author Roberto E. Escobar + */ +public class UiToTestBlam extends AbstractBlam { + private static final String EMPTY_STRING = ""; + + @Override + public String getName() { + return "UI To Test Report"; + } + + @Override + public Collection<String> getCategories() { + return Arrays.asList("Define.Trace"); + } + + @Override + public String getDescriptionUsage() { + return "Usage Info here"; + } + + @Override + public String getXWidgetsXml() { + StringBuilder builder = new StringBuilder(); + builder.append("<xWidgets>"); + builder.append("<XWidget xwidgetType=\"XFileSelectionDialog\" displayName=\"Select UI List File\" />"); + builder.append("<XWidget xwidgetType=\"XBranchSelectWidget\" displayName=\"Requirements Branch\" />"); + builder.append("</xWidgets>"); + return builder.toString(); + } + + @Override + public void runOperation(VariableMap variableMap, IProgressMonitor monitor) throws Exception { + String fileName = variableMap.getString("Select UI List File"); + Branch branch = variableMap.getBranch("Requirements Branch"); + + if (branch == null) { + throw new OseeArgumentException("Branch cannot be null"); + } + + XResultData resultData = new XResultData(); + resultData.log("UI To Test Traceability"); + + Set<Artifact> toTrace = new HashSet<Artifact>(); + String input = null; + + monitor.beginTask("UI To Test Trace Report", IProgressMonitor.UNKNOWN); + try { + monitor.subTask("Gathering Requirements"); + if (Strings.isValid(fileName)) { + input = getUIsFromFile(monitor, fileName); + } + + if (Strings.isValid(input)) { + for (String ui : input.split("\n")) { + String toGet = ui.trim(); toTrace.addAll(ArtifactQuery.getArtifactListFromName(toGet, branch, EXCLUDE_DELETED)); - }
- } else {
- RequirementData requirements = new RequirementData(branch);
- requirements.initialize(monitor);
- toTrace.addAll(requirements.getAllSwRequirements());
- }
-
- StringWriter appendable = new StringWriter();
-
- monitor.subTask("Gathering Test Unit Trace");
-
- if (toTrace.isEmpty()) {
- addRow(appendable, "No Requirements found");
- } else {
- addRow(appendable, String.format("[%s] Requirements Found", toTrace.size()));
-
- List<String> headers = new ArrayList<String>();
- for (Column column : Column.values()) {
- headers.add(column.name());
- }
- addRow(appendable, headers.toArray(new String[headers.size()]));
- for (Artifact requirement : toTrace) {
- processTrace(appendable, requirement, "Verified By", CoreRelationTypes.Verification__Verifier);
- processTrace(appendable, requirement, "Used By", CoreRelationTypes.Uses__TestUnit);
- processTrace(appendable, requirement, "Validated By", CoreRelationTypes.Validation__Validator);
- }
- }
-
- if (appendable.getBuffer().length() > 0) {
- String outFileName = "UI_To_TestUnit." + Lib.getDateTimeString() + ".csv";
- IFile iFile = OseeData.getIFile(outFileName);
- AIFile.writeToFile(iFile, appendable.toString());
- Program.launch(iFile.getLocation().toOSString());
- }
- } finally {
- monitor.subTask("Done");
- System.gc();
- }
- }
-
- private void addRow(Appendable appendable, String... data) throws OseeCoreException {
- if (data != null && data.length > 0) {
- try {
- for (int index = 0; index < data.length; index++) {
- appendable.append("\"");
- appendable.append(data[index]);
- appendable.append("\"");
- if (index + 1 < data.length) {
- appendable.append(",");
- }
- }
- appendable.append("\n");
- } catch (Exception ex) {
- OseeExceptions.wrapAndThrow(ex);
- }
- }
- }
-
- private String getUIsFromFile(IProgressMonitor monitor, String filePath) throws Exception {
- String input;
- File file = new File(filePath);
- if (file == null || !file.exists()) {
- throw new OseeArgumentException("UI list file not accessible");
- }
- IFileStore fileStore = EFS.getStore(file.toURI());
- InputStream inputStream = null;
- try {
- inputStream = new BufferedInputStream(fileStore.openInputStream(EFS.NONE, monitor));
- input = Lib.inputStreamToString(inputStream);
- } finally {
- if (inputStream != null) {
- inputStream.close();
- }
- }
- return input;
- }
-
- private String[] asArray(String... data) {
- String[] toReturn = new String[Column.values().length];
- if (data != null && data.length > 0) {
- for (int index = 0; index < toReturn.length; index++) {
- if (data.length > index) {
- toReturn[index] = data[index];
- }
- }
- }
- return toReturn;
- }
-
- private void processTrace(Appendable appendable, Artifact requirement, String testType, IRelationEnumeration relationType) throws OseeCoreException {
- String uiTitle = requirement.getName();
- String uiType = requirement.getArtifactTypeName();
-
- List<Artifact> testUnits = requirement.getRelatedArtifacts(relationType);
- if (testUnits.isEmpty()) {
- addRow(appendable, asArray(uiTitle, uiType, "NONE", "NONE", EMPTY_STRING, EMPTY_STRING, EMPTY_STRING,
- EMPTY_STRING));
- } else {
- for (Artifact testUnit : testUnits) {
- String testUnitName = testUnit.getName();
- String testUnitType = testUnit.getArtifactTypeName();
- List<String> verified = getTrace(testUnit, CoreRelationTypes.Verification__Requirement);
- List<String> used = getTrace(testUnit, CoreRelationTypes.Uses__Requirement);
- List<String> validates = getTrace(testUnit, CoreRelationTypes.Validation__Requirement);
- String verifyStr = org.eclipse.osee.framework.jdk.core.util.Collections.toString(verified, ",");
- String usesStr = org.eclipse.osee.framework.jdk.core.util.Collections.toString(used, ",");
- String validatesStr = org.eclipse.osee.framework.jdk.core.util.Collections.toString(validates, ",");
-
- addRow(appendable, asArray(uiTitle, uiType, testType, testUnitName, testUnitType, verifyStr, validatesStr,
- usesStr));
- }
- }
- }
-
- private List<String> getTrace(Artifact testUnit, IRelationEnumeration relation) throws OseeCoreException {
- List<String> toReturn = new ArrayList<String>();
- for (Artifact item : testUnit.getRelatedArtifacts(relation)) {
- toReturn.add(item.getName());
- }
- if (toReturn.isEmpty()) {
- toReturn.add("NONE");
- }
- return toReturn;
- }
-
- private static enum Column {
+ } + } else { + RequirementData requirements = new RequirementData(branch); + requirements.initialize(monitor); + toTrace.addAll(requirements.getAllSwRequirements()); + } + + StringWriter appendable = new StringWriter(); + + monitor.subTask("Gathering Test Unit Trace"); + + if (toTrace.isEmpty()) { + addRow(appendable, "No Requirements found"); + } else { + addRow(appendable, String.format("[%s] Requirements Found", toTrace.size())); + + List<String> headers = new ArrayList<String>(); + for (Column column : Column.values()) { + headers.add(column.name()); + } + addRow(appendable, headers.toArray(new String[headers.size()])); + for (Artifact requirement : toTrace) { + processTrace(appendable, requirement, "Verified By", CoreRelationTypes.Verification__Verifier); + processTrace(appendable, requirement, "Used By", CoreRelationTypes.Uses__TestUnit); + processTrace(appendable, requirement, "Validated By", CoreRelationTypes.Validation__Validator); + } + } + + if (appendable.getBuffer().length() > 0) { + String outFileName = "UI_To_TestUnit." + Lib.getDateTimeString() + ".csv"; + IFile iFile = OseeData.getIFile(outFileName); + AIFile.writeToFile(iFile, appendable.toString()); + Program.launch(iFile.getLocation().toOSString()); + } + } finally { + monitor.subTask("Done"); + System.gc(); + } + } + + private void addRow(Appendable appendable, String... data) throws OseeCoreException { + if (data != null && data.length > 0) { + try { + for (int index = 0; index < data.length; index++) { + appendable.append("\""); + appendable.append(data[index]); + appendable.append("\""); + if (index + 1 < data.length) { + appendable.append(","); + } + } + appendable.append("\n"); + } catch (Exception ex) { + OseeExceptions.wrapAndThrow(ex); + } + } + } + + private String getUIsFromFile(IProgressMonitor monitor, String filePath) throws Exception { + String input; + File file = new File(filePath); + if (file == null || !file.exists()) { + throw new OseeArgumentException("UI list file not accessible"); + } + IFileStore fileStore = EFS.getStore(file.toURI()); + InputStream inputStream = null; + try { + inputStream = new BufferedInputStream(fileStore.openInputStream(EFS.NONE, monitor)); + input = Lib.inputStreamToString(inputStream); + } finally { + if (inputStream != null) { + inputStream.close(); + } + } + return input; + } + + private String[] asArray(String... data) { + String[] toReturn = new String[Column.values().length]; + if (data != null && data.length > 0) { + for (int index = 0; index < toReturn.length; index++) { + if (data.length > index) { + toReturn[index] = data[index]; + } + } + } + return toReturn; + } + + private void processTrace(Appendable appendable, Artifact requirement, String testType, IRelationEnumeration relationType) throws OseeCoreException { + String uiTitle = requirement.getName(); + String uiType = requirement.getArtifactTypeName(); + + List<Artifact> testUnits = requirement.getRelatedArtifacts(relationType); + if (testUnits.isEmpty()) { + addRow(appendable, asArray(uiTitle, uiType, "NONE", "NONE", EMPTY_STRING, EMPTY_STRING, EMPTY_STRING, + EMPTY_STRING)); + } else { + for (Artifact testUnit : testUnits) { + String testUnitName = testUnit.getName(); + String testUnitType = testUnit.getArtifactTypeName(); + List<String> verified = getTrace(testUnit, CoreRelationTypes.Verification__Requirement); + List<String> used = getTrace(testUnit, CoreRelationTypes.Uses__Requirement); + List<String> validates = getTrace(testUnit, CoreRelationTypes.Validation__Requirement); + String verifyStr = org.eclipse.osee.framework.jdk.core.util.Collections.toString(verified, ","); + String usesStr = org.eclipse.osee.framework.jdk.core.util.Collections.toString(used, ","); + String validatesStr = org.eclipse.osee.framework.jdk.core.util.Collections.toString(validates, ","); + + addRow(appendable, asArray(uiTitle, uiType, testType, testUnitName, testUnitType, verifyStr, validatesStr, + usesStr)); + } + } + } + + private List<String> getTrace(Artifact testUnit, IRelationEnumeration relation) throws OseeCoreException { + List<String> toReturn = new ArrayList<String>(); + for (Artifact item : testUnit.getRelatedArtifacts(relation)) { + toReturn.add(item.getName()); + } + if (toReturn.isEmpty()) { + toReturn.add("NONE"); + } + return toReturn; + } + + private static enum Column { UI_Title, Requirement_Type, Relates_To_Test_Unit, Test_Unit_Name, Test_Unit_Type, Verified_By, Validated_By, - Used_By;
- }
-
-}
+ Used_By; + } + +} |