1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/*******************************************************************************
* Copyright (c) 2013 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.report;
import java.io.File;
import java.io.IOException;
import java.io.Writer;
import java.util.Collection;
import org.eclipse.osee.define.report.internal.SafetyCriticalityLookup;
import org.eclipse.osee.define.report.internal.SafetyInformationAccumulator;
import org.eclipse.osee.define.report.internal.TraceAccumulator;
import org.eclipse.osee.define.report.internal.TraceMatch;
import org.eclipse.osee.define.report.internal.util.ComponentUtil;
import org.eclipse.osee.framework.core.enums.CoreArtifactTypes;
import org.eclipse.osee.framework.core.enums.CoreAttributeTypes;
import org.eclipse.osee.framework.core.enums.CoreRelationTypes;
import org.eclipse.osee.framework.jdk.core.type.ResultSet;
import org.eclipse.osee.framework.jdk.core.util.Strings;
import org.eclipse.osee.framework.jdk.core.util.io.xml.ExcelXmlWriter;
import org.eclipse.osee.framework.jdk.core.util.io.xml.ISheetWriter;
import org.eclipse.osee.logger.Log;
import org.eclipse.osee.orcs.OrcsApi;
import org.eclipse.osee.orcs.data.ArtifactReadable;
import org.eclipse.osee.orcs.search.QueryFactory;
public class SafetyReportGenerator {
private SafetyInformationAccumulator accumulator;
private QueryFactory queryFactory;
private ComponentUtil componentUtil;
private final TraceMatch match = new TraceMatch("\\^SRS\\s*([^;]+);?", "\\[?(\\{[^\\}]+\\})(.*)");
private final TraceAccumulator traces = new TraceAccumulator(".*\\.(java|ada|ads|adb|c|h)", match);
private long branchUuid;
private final Log logger;
public static int SYSTEM_REQUIREMENT_INDEX = 8;
public static int SUBSYSTEM_FUNCTION_INDEX = 9;
public static int SUBSYSTEM_INDEX = 13;
public static int SOFTWARE_REQUIREMENT_INDEX = 19;
public static int CODE_UNIT_INDEX = 28;
private final String[] columnHeadings = {
"System Function",
"Severity Category",
"SFHA Hazard(s)",
"Hazard Level Test",
"Software Safety Impact",
"System FDAL",
"System FDAL Rationale",
"Paragraph #",
"System Requirement Name",
"Subsystem Function",
"Subsystem Severity Category",
"Subsystem FDAL",
"Subsystem FDAL Rationale",
CoreAttributeTypes.Subsystem.getName(),
"Paragraph #",
"Subsystem Requirement Name",
"Subsystem Requirement IDAL",
"Subsystem Requirement IDAL Rationale",
"Subsystem Requirement Level Check",
CoreArtifactTypes.SoftwareRequirement.getName(),
"IDAL",
"IDAL Rationale",
"Software Control Category",
"Software Control Category Rationale",
"Boeing Equivalent SW Qual Level",
"Functional Category",
"SW Partition",
"SW CSU",
"SW Code Unit"};
public SafetyReportGenerator(Log logger) {
this.logger = logger;
}
private void init(OrcsApi orcsApi, long branchUuid, ISheetWriter writer) {
accumulator = new SafetyInformationAccumulator(this, writer);
queryFactory = orcsApi.getQueryFactory();
this.branchUuid = branchUuid;
componentUtil = new ComponentUtil(branchUuid, orcsApi);
}
public void runOperation(OrcsApi providedOrcs, long branchUuid, String codeRoot, Writer providedWriter) throws IOException {
ISheetWriter writer = new ExcelXmlWriter(providedWriter);
init(providedOrcs, branchUuid, writer);
boolean doTracability = false;
if (codeRoot != null && codeRoot.isEmpty() != true) {
doTracability = true;
}
if (doTracability) {
File root = new File(codeRoot);
traces.extractTraces(root);
}
ArtifactReadable functionsFolder =
queryFactory.fromBranch(branchUuid).andIsOfType(CoreArtifactTypes.Folder).andNameEquals(
"System Functions").getResults().getExactlyOne();
processSystemFunctions(functionsFolder, writer);
writer.endWorkbook();
}
private void processSystemFunctions(ArtifactReadable functionsFolder, ISheetWriter writer) throws IOException {
writer.startSheet("report", columnHeadings.length);
writer.writeRow((Object[]) columnHeadings);
for (ArtifactReadable systemFunction : functionsFolder.getDescendants()) {
if (systemFunction.isOfType(CoreArtifactTypes.SystemFunction)) {
writer.writeCell(systemFunction.getName());
accumulator.reset(systemFunction);
accumulator.buildSubsystemsRequirementsMap(systemFunction);
String sevCat;
if (systemFunction.getAttributes(CoreAttributeTypes.SeverityCategory).size() != 1) {
logger.debug("found too many attributes on %s", systemFunction.toString());
sevCat = systemFunction.getAttributes(
CoreAttributeTypes.SeverityCategory).iterator().next().getDisplayableString();
} else {
sevCat = systemFunction.getSoleAttributeAsString(CoreAttributeTypes.SeverityCategory);
}
writer.writeCell(sevCat);
writeSFHAInfo(systemFunction, sevCat, writer);
writer.writeCell(systemFunction.getSoleAttributeAsString(CoreAttributeTypes.SoftwareSafetyImpact, ""));
writer.writeCell(systemFunction.getSoleAttributeAsString(CoreAttributeTypes.FunctionalDAL, ""));
writer.writeCell(systemFunction.getSoleAttributeAsString(CoreAttributeTypes.FunctionalDALRationale, ""));
for (ArtifactReadable systemRequirement : systemFunction.getRelated(
CoreRelationTypes.Design__Requirement)) {
writer.writeCell(systemRequirement.getSoleAttributeValue(CoreAttributeTypes.ParagraphNumber, ""));
writer.writeCell(systemRequirement.getName(), SYSTEM_REQUIREMENT_INDEX);
accumulator.output();
}
writer.endRow();
}
}
writer.endSheet();
}
private void writeSFHAInfo(ArtifactReadable systemFunction, String sevCat, ISheetWriter writer) throws IOException {
ResultSet<ArtifactReadable> results = systemFunction.getRelated(CoreRelationTypes.Safety__Safety_Assessment);
if (results.isEmpty()) {
writer.writeCell("No SFHA Hazards found");
writer.writeCell("N/A");
} else {
writer.writeCell(getSFHAHazards(results));
writer.writeCell(compareHazardLevel(results, sevCat));
}
}
private String getSFHAHazards(ResultSet<ArtifactReadable> results) {
StringBuilder sb = new StringBuilder();
for (ArtifactReadable assessment : results) {
if (sb.length() > 0) {
sb.append(", ");
}
sb.append(assessment.getSoleAttributeAsString(CoreAttributeTypes.ParagraphNumber, ""));
sb.append(" ");
sb.append(assessment.getSoleAttributeAsString(CoreAttributeTypes.Name, ""));
sb.append(" ");
sb.append(assessment.getSoleAttributeValue(CoreAttributeTypes.Sfha, ""));
}
return sb.toString();
}
private String compareHazardLevel(ResultSet<ArtifactReadable> results, String sevCat) {
String toReturn = "System Function Severity Category invalid";
try {
Integer sevCatLevel = SafetyCriticalityLookup.getSeverityLevel(sevCat);
toReturn = "good: " + sevCat;
Integer sfhaSevCatLevel;
for (ArtifactReadable assessment : results) {
String sfha = assessment.getSoleAttributeAsString(CoreAttributeTypes.Sfha);
if (Strings.isValid(sfha)) {
String[] sfhaSevCat = sfha.split(" ");
sfhaSevCatLevel = SafetyCriticalityLookup.getSeverityLevel(sfhaSevCat[2]);
if (sevCatLevel > sfhaSevCatLevel) {
toReturn = "bad: " + sevCat + " > " + sfhaSevCat[2];
}
}
}
} catch (Exception ex) {
toReturn = ex.getMessage();
}
return toReturn;
}
public Collection<String> getRequirementToCodeUnitsValues(ArtifactReadable softwareRequirement) {
return traces.getFiles(softwareRequirement.getName());
}
public ComponentUtil getComponentUtil() {
return componentUtil;
}
}
|
