org.spdx.tools.CompareSpdxDocs Maven / Gradle / Ivy
/**
* Copyright (c) 2013 Source Auditor Inc.
* Copyright (c) 2013 Black Duck Software Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.spdx.tools;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.PrintStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.spdx.compare.SpdxCompareException;
import org.spdx.compare.SpdxComparer;
import org.spdx.compare.SpdxComparer.SPDXReviewDifference;
import org.spdx.compare.SpdxFileDifference;
import org.spdx.compare.SpdxLicenseDifference;
import org.spdx.compare.SpdxPackageComparer;
import org.spdx.rdfparser.InvalidSPDXAnalysisException;
import org.spdx.rdfparser.SPDXCreatorInformation;
import org.spdx.rdfparser.SPDXDocumentFactory;
import org.spdx.rdfparser.SPDXReview;
import org.spdx.rdfparser.SpdxPackageVerificationCode;
import org.spdx.rdfparser.license.AnyLicenseInfo;
import org.spdx.rdfparser.license.ExtractedLicenseInfo;
import org.spdx.rdfparser.model.Annotation;
import org.spdx.rdfparser.model.Checksum;
import org.spdx.rdfparser.model.DoapProject;
import org.spdx.rdfparser.model.ExternalDocumentRef;
import org.spdx.rdfparser.model.Relationship;
import org.spdx.rdfparser.model.SpdxDocument;
import org.spdx.rdfparser.model.SpdxFile;
import org.spdx.rdfparser.model.SpdxFile.FileType;
import org.spdx.rdfparser.model.SpdxPackage;
import org.spdx.tag.InvalidFileFormatException;
import org.spdx.tag.InvalidSpdxTagFileException;
import com.google.common.base.Joiner;
import antlr.RecognitionException;
/**
* Command line application to compare two SPDX documents
* Usage: CompareSpdxDoc doc1 doc2 [output]
* where doc1 and doc2 are two SPDX documents in either RDF/XML or tag/value format
* and [output] is an optional SPDX document
*
* @author Gary O'Neall
*
*/
public class CompareSpdxDocs {
static final Logger logger = LoggerFactory.getLogger(CompareSpdxDocs.class.getName());
static final int MIN_ARGS = 2;
static final int MAX_ARGS = 3;
static final int ERROR_STATUS = 1;
//TODO: Change implementation to use a properties file for the standard strings OR use Mustache
/**
* @param args CompareFile1, CompareFile2, optional output file
* @throws Exception
*/
public static void main(String[] args) throws Exception {
if (args.length < MIN_ARGS) {
System.out.println("Insufficient arguments");
usage();
System.exit(ERROR_STATUS);
}
if (args.length > MAX_ARGS) {
System.out.println("Too many arguments specified");
usage();
System.exit(ERROR_STATUS);
}
SpdxDocument spdxDoc1 = null;
try {
List warnings = new ArrayList();
spdxDoc1 = openRdfOrTagDoc(args[0].trim(), warnings);
if (!warnings.isEmpty()) {
System.out.println("Verification errors were found in "+args[0].trim()+":");
if (!warnings.isEmpty()) {
System.out.println("The following warnings and or verification errors were found:");
for (String warning:warnings) {
System.out.println("\t"+warning);
}
}
}
} catch (SpdxCompareException e) {
System.out.println("Error opening "+args[0].trim()+":"+e.getMessage());
usage();
System.exit(ERROR_STATUS);
}
SpdxDocument spdxDoc2 = null;
try {
List warnings = new ArrayList();
spdxDoc2 = openRdfOrTagDoc(args[1].trim(), warnings);
if (!warnings.isEmpty()) {
System.out.println("Verification errors were found in "+args[0].trim()+":");
if (!warnings.isEmpty()) {
System.out.println("The following warnings and or verification errors were found:");
for (String warning:warnings) {
System.out.println("\t"+warning);
}
}
}
} catch (SpdxCompareException e) {
System.out.println("Error opening "+args[1].trim()+":"+e.getMessage());
usage();
System.exit(ERROR_STATUS);
}
PrintStream output = null;
if (args.length > 2) {
File outFile = new File(args[2].trim());
if (outFile.exists()) {
System.out.println("Output file "+args[2].trim()+" already exists.");
System.exit(ERROR_STATUS);
}
try {
if (!outFile.createNewFile()) {
System.out.println("Can not create output file "+args[2].trim());
System.exit(ERROR_STATUS);
}
} catch (IOException e) {
System.out.println("Error creating output file "+args[2].trim());
System.exit(ERROR_STATUS);
}
try {
output = new PrintStream(outFile);
} catch (FileNotFoundException e) {
System.out.println("Error opening output file "+args[2].trim()+" for printing ("+e.getMessage());
System.exit(ERROR_STATUS);
}
} else {
output = System.out;
}
try {
List doc1VerificationErrors = spdxDoc1.verify();
if (doc1VerificationErrors.size() > 0) {
output.println("Warning - The SPDX document "+args[0].trim()+" contains the following verification errors:");
printList(doc1VerificationErrors, output);
}
List doc2VerificationErrors = spdxDoc2.verify();
if (doc2VerificationErrors.size() > 0) {
output.println("Warning - The SPDX document "+args[1].trim()+" contains the following verification errors:");
printList(doc2VerificationErrors, output);
}
try {
SpdxComparer comparer = new SpdxComparer();
comparer.compare(spdxDoc1, spdxDoc2);
// create some more readable document names for the compare results
String docName1 = convertDocName(args[0]);
String docName2 = convertDocName(args[1]);
if (docName1.equals(docName2)) {
docName1 = args[0];
docName2 = args[1];
}
printCompareResults(comparer, docName1, docName2, spdxDoc1, spdxDoc2, output);
} catch (SpdxCompareException e) {
output.println("Error in comparing SPDX documents: "+e.getMessage());
System.exit(ERROR_STATUS);
} catch (InvalidSPDXAnalysisException e) {
output.println("SPDX Analysis Error in comparing SPDX documents: "+e.getMessage());
System.exit(ERROR_STATUS);
}
} finally {
if (output != System.out) {
output.close();
}
}
System.exit(0);
}
/**
* Converts a file path or URL to a shorter document name
* @param docPath
* @return
*/
protected static String convertDocName(String docPath) {
if (docPath.contains(File.separator)) {
File docFile = new File(docPath);
return docFile.getName();
} else {
try {
URI uri = new URI(docPath);
String path = uri.getPath();
return path;
} catch (URISyntaxException e) {
return docPath;
}
}
}
/**
* Prints a list of strings
* @param list
* @param output
*/
private static void printList(List list, PrintStream output) {
for(int i = 0;i < list.size(); i++) {
output.println(list.get(i));
}
}
/**
* @param comparer
* @param spdxDoc2
* @param spdxDoc1
* @param output
* @throws InvalidSPDXAnalysisException
* @throws SpdxCompareException
*/
private static void printCompareResults(SpdxComparer comparer, String doc1Name,
String doc2Name, SpdxDocument spdxDoc1, SpdxDocument spdxDoc2, PrintStream output) throws SpdxCompareException, InvalidSPDXAnalysisException {
output.println("Comparing SPDX Documents: "+doc1Name+
" and "+doc2Name);
output.println(doc1Name + " Namespace: "+comparer.getSpdxDoc(0).getDocumentNamespace());
output.println(doc2Name + " NamespaceI: "+comparer.getSpdxDoc(1).getDocumentNamespace());
if (!comparer.isDifferenceFound()) {
output.println("Both SPDX documents match - no differences found.");
return;
}
// spdx version
if (!comparer.isSpdxVersionEqual()) {
output.println("SPDX versions differ.");
output.println("\t"+doc1Name+":"+comparer.getSpdxDoc(0).getSpecVersion());
output.println("\t"+doc2Name+":"+comparer.getSpdxDoc(1).getSpecVersion());
}
// data license
if (!comparer.isDataLicenseEqual()) {
output.println("SPDX data license differ.");
output.println("\t"+doc1Name+":"+comparer.getSpdxDoc(0).getDataLicense().toString());
output.println("\t"+doc2Name+":"+comparer.getSpdxDoc(1).getDataLicense().toString());
}
// external document references
if (!comparer.isExternalDcoumentRefsEquals()) {
ExternalDocumentRef[] uniqueA = comparer.getUniqueExternalDocumentRefs(0, 1);
if (uniqueA != null && uniqueA.length > 0) {
output.println("The following external document references were only found in "+doc1Name);
for (int i = 0; i < uniqueA.length; i++) {
printExternalDocumentRef(uniqueA[i], output);
}
}
ExternalDocumentRef[] uniqueB = comparer.getUniqueExternalDocumentRefs(1, 0);
if (uniqueB != null && uniqueB.length > 0) {
output.println("The following external document references were only found in "+doc2Name);
for (int i = 0; i < uniqueB.length; i++) {
printExternalDocumentRef(uniqueB[i], output);
}
}
}
// document comment
if (!comparer.isDocumentCommentsEqual()) {
output.println("SPDX document comments differ.");
if (comparer.getSpdxDoc(0).getComment() == null) {
output.println("\t"+doc1Name+": [No comment]");
} else {
output.println("\t"+doc1Name+":"+comparer.getSpdxDoc(0).getComment());
}
if (comparer.getSpdxDoc(1).getComment() == null) {
output.println("\t"+doc2Name+": [No comment]");
} else {
output.println("\t"+doc2Name+":"+comparer.getSpdxDoc(1).getComment());
}
}
// Annotations
if (!comparer.isDocumentAnnotationsEquals()) {
Annotation[] uniqueA = comparer.getUniqueDocumentAnnotations(0, 1);
if (uniqueA != null && uniqueA.length > 0) {
output.println("The following document annotations were only found in "+doc1Name);
for (int i = 0; i < uniqueA.length; i++) {
printAnnotation(uniqueA[i], output);
}
}
Annotation[] uniqueB = comparer.getUniqueDocumentAnnotations(1, 0);
if (uniqueB != null && uniqueB.length > 0) {
output.println("The following document annotations were only found in "+doc2Name);
for (int i = 0; i < uniqueB.length; i++) {
printAnnotation(uniqueB[i], output);
}
}
}
// creator information
printCreatorCompareResults(comparer, doc1Name, doc2Name, output);
// Relationships
if (!comparer.isDocumentRelationshipsEquals()) {
Relationship[] uniqueA = comparer.getUniqueDocumentRelationship(0, 1);
if (uniqueA != null && uniqueA.length > 0) {
output.println("The following document relationships were only found in "+doc1Name);
for (int i = 0; i < uniqueA.length; i++) {
printRelationship(uniqueA[i], "SpdxRef-DOCUMENT", output);
}
}
Relationship[] uniqueB = comparer.getUniqueDocumentRelationship(1, 0);
if (uniqueB != null && uniqueB.length > 0) {
output.println("The following document relationships were only found in "+doc2Name);
for (int i = 0; i < uniqueB.length; i++) {
printRelationship(uniqueB[i], "SpdxRef-DOCUMENT", output);
}
}
}
// package
printPackageCompareResults(comparer, doc1Name, doc2Name, spdxDoc1, spdxDoc2, output);
// file
printFileCompareResults(comparer, doc1Name, doc2Name, output);
// other license information
printExtractedLicenseCompareResults(comparer, doc1Name, doc2Name, output);
// reviewer
printReviewerCompareResults(comparer, doc1Name, doc2Name, output);
}
/**
* @param relationship
* @param output
*/
private static void printRelationship(Relationship relationship, String elementId,
PrintStream output) {
String relatedElementId = "[NONE]";
if (relationship.getRelatedSpdxElement() != null) {
relatedElementId = relationship.getRelatedSpdxElement().getId();
}
output.println("\tRelationship: " +
elementId + relationship.getRelationshipType().toTag() +
" " + relatedElementId);
if (relationship.getComment() != null && !relationship.getComment().isEmpty()) {
output.println("\tRelationshipComment: " + relationship.getComment());
}
}
/**
* @param annotation
* @param output
*/
private static void printAnnotation(Annotation annotation,
PrintStream output) {
output.println("\tAnnotator: " + annotation.getAnnotator());
output.println("\tAnnotationDate: " + annotation.getAnnotationDate());
output.println("\tAnnotationType: " + annotation.getAnnotationType().getTag());
output.println("\tAnnotationComment: " + annotation.getComment());
}
/**
* @param externalDocumentRef
* @param output
* @throws InvalidSPDXAnalysisException
*/
private static void printExternalDocumentRef(
ExternalDocumentRef externalDocumentRef, PrintStream output) throws InvalidSPDXAnalysisException {
output.println("\tExternalDocumentRef: "+externalDocumentRef.getExternalDocumentId()+
" "+externalDocumentRef.getSpdxDocumentNamespace()+" SHA1:"+
externalDocumentRef.getChecksum().getValue());
}
/**
* @param comparer
* @param doc1Name
* @param doc2Name
* @param output
* @throws SpdxCompareException
*/
private static void printFileCompareResults(SpdxComparer comparer,
String doc1Name, String doc2Name, PrintStream output) throws SpdxCompareException {
if (!comparer.isfilesEquals()) {
SpdxFile[] inDoc1notInDoc2 = comparer.getUniqueFiles(0, 1);
if (inDoc1notInDoc2 != null && inDoc1notInDoc2.length > 0) {
output.println("The following file(s) are in "+doc1Name+
" but not in "+doc2Name);
for (int i = 0; i < inDoc1notInDoc2.length; i++) {
printSpdxFile(inDoc1notInDoc2[i], output);
}
}
SpdxFile[] inDoc2notInDoc1 = comparer.getUniqueFiles(1, 0);
if (inDoc2notInDoc1 != null && inDoc2notInDoc1.length > 0) {
output.println("The following file(s) are in "+doc2Name+
" but not in "+doc1Name);
for (int i = 0; i < inDoc2notInDoc1.length; i++) {
printSpdxFile(inDoc2notInDoc1[i], output);
}
}
SpdxFileDifference[] fileDifferences = comparer.getFileDifferences(0, 1);
if (fileDifferences != null && fileDifferences.length > 0) {
for (int i = 0; i < fileDifferences.length; i++) {
printFileDifference(fileDifferences[i], output, doc1Name, doc2Name);
}
}
}
}
/**
* Displays the file difference information
* @param spdxFileDifference
* @param output
* @param doc1Name
* @param doc2Name
*/
private static void printFileDifference(
SpdxFileDifference spdxFileDifference, PrintStream output,
String doc1Name, String doc2Name) {
if (!spdxFileDifference.isConcludedLicenseEquals()) {
output.println("File concluded license differ for file "+spdxFileDifference.getFileName()+":");
output.println("\t"+doc1Name+":"+spdxFileDifference.getConcludedLicenseA());
output.println("\t"+doc2Name+":"+spdxFileDifference.getConcludedLicenseB());
}
if (!spdxFileDifference.isCopyrightsEqual()) {
output.println("File copyrights differ for file "+spdxFileDifference.getFileName()+":");
output.println("\t"+doc1Name+":"+spdxFileDifference.getCopyrightA());
output.println("\t"+doc2Name+":"+spdxFileDifference.getCopyrightB());
}
if (!spdxFileDifference.isCommentsEquals()) {
output.println("File comments differ for file "+spdxFileDifference.getFileName()+":");
output.println("\t"+doc1Name+":"+spdxFileDifference.getCommentA());
output.println("\t"+doc2Name+":"+spdxFileDifference.getCommentB());
}
if (!spdxFileDifference.isChecksumsEquals()) {
Checksum[] uniqueA = spdxFileDifference.getUniqueChecksumsA();
if (uniqueA != null && uniqueA.length > 0) {
output.println("Checksums only in document "+doc1Name+" for file "+spdxFileDifference.getFileName()+":");
for (int i = 0; i < uniqueA.length; i++) {
printChecksum(uniqueA[i], output);
}
}
Checksum[] uniqueB = spdxFileDifference.getUniqueChecksumsB();
if (uniqueB != null && uniqueB.length > 0) {
output.println("Checksums only in document "+doc2Name+" for file "+spdxFileDifference.getFileName()+":");
for (int i = 0; i < uniqueB.length; i++) {
printChecksum(uniqueB[i], output);
}
}
}
if (!spdxFileDifference.isTypeEqual()) {
output.println("File types differ for file "+spdxFileDifference.getFileName()+":");
output.println("\t"+doc1Name+":"+formatFileTypes(spdxFileDifference.getFileTypeA()));
output.println("\t"+doc2Name+":"+formatFileTypes(spdxFileDifference.getFileTypeB()));
}
if (!spdxFileDifference.isContributorsEqual()) {
output.println("File contributors differ for file "+spdxFileDifference.getFileName()+":");
output.println("\t"+doc1Name+":"+spdxFileDifference.getContributorsAAsString());
output.println("\t"+doc2Name+":"+spdxFileDifference.getContributorsBAsString());
}
if (!spdxFileDifference.isFileDependenciesEqual()) {
output.println("File contributors differ for file "+spdxFileDifference.getFileName()+":");
output.println("\t"+doc1Name+"dependencies:"+spdxFileDifference.getFileDependenciesAAsString());
output.println("\t"+doc2Name+":"+spdxFileDifference.getFileDependenciesBAsString());
}
if (!spdxFileDifference.isSeenLicensesEquals()) {
if (spdxFileDifference.getUniqueSeenLicensesA() != null &&
spdxFileDifference.getUniqueSeenLicensesA().length > 0) {
output.println("The following license information was only found in "+
doc1Name+" for file "+spdxFileDifference.getFileName());
for (int i = 0; i < spdxFileDifference.getUniqueSeenLicensesA().length; i++) {
output.println("\t"+spdxFileDifference.getUniqueSeenLicensesA()[i].toString());
}
}
if (spdxFileDifference.getUniqueSeenLicensesB() != null &&
spdxFileDifference.getUniqueSeenLicensesB().length > 0) {
output.println("The following license information was only found in "+
doc2Name+" for file "+spdxFileDifference.getFileName());
for (int i = 0; i < spdxFileDifference.getUniqueSeenLicensesB().length; i++) {
output.println("\t"+spdxFileDifference.getUniqueSeenLicensesB()[i].toString());
}
}
}
if (!spdxFileDifference.isArtifactOfsEquals()) {
if (spdxFileDifference.getUniqueArtifactOfA() != null &&
spdxFileDifference.getUniqueArtifactOfA().length > 0) {
output.println("The following artifactOf information was only found in "+
doc1Name+" for file "+spdxFileDifference.getFileName());
for (int i = 0; i < spdxFileDifference.getUniqueArtifactOfA().length; i++) {
printDoapProject(spdxFileDifference.getUniqueArtifactOfA()[i], output);
}
}
if (spdxFileDifference.getUniqueArtifactOfB() != null &&
spdxFileDifference.getUniqueArtifactOfB().length > 0) {
output.println("The following artifactOf information was only found in "+
doc2Name+" for file "+spdxFileDifference.getFileName());
for (int i = 0; i < spdxFileDifference.getUniqueArtifactOfB().length; i++) {
printDoapProject(spdxFileDifference.getUniqueArtifactOfB()[i], output);
}
}
}
// relationships
if (!spdxFileDifference.isRelationshipsEquals()) {
Relationship[] uniqueA = spdxFileDifference.getUniqueRelationshipA();
if (uniqueA != null && uniqueA.length > 0) {
output.println("The following relationships are only present in "+doc1Name+":");
for (int i = 0; i < uniqueA.length; i++) {
printRelationship(uniqueA[i], spdxFileDifference.getSpdxIdA(), output);
}
}
Relationship[] uniqueB = spdxFileDifference.getUniqueRelationshipB();
if (uniqueB != null && uniqueB.length > 0) {
output.println("The following relationships are only present in "+doc2Name+":");
for (int i = 0; i < uniqueB.length; i++) {
printRelationship(uniqueB[i], spdxFileDifference.getSpdxIdB(), output);
}
}
}
// annotations
if (!spdxFileDifference.isAnnotationsEquals()) {
Annotation[] uniqueA = spdxFileDifference.getUniqueAnnotationsA();
if (uniqueA != null && uniqueA.length > 0) {
output.println("The following annotations are only present in "+doc1Name+":");
for (int i = 0; i < uniqueA.length; i++) {
printAnnotation(uniqueA[i], output);
}
}
Annotation[] uniqueB = spdxFileDifference.getUniqueAnnotationsB();
if (uniqueB != null && uniqueB.length > 0) {
output.println("The following annotations are only present in "+doc2Name+":");
for (int i = 0; i < uniqueB.length; i++) {
printAnnotation(uniqueB[i], output);
}
}
}
}
/**
* Formats an array of file types into a comma delimited list
* @param fileType
* @return
*/
private static String formatFileTypes(FileType[] fileTypes) {
if (fileTypes == null || fileTypes.length == 0) {
return "";
}
Arrays.sort(fileTypes);
StringBuilder sb = new StringBuilder(fileTypes[0].getTag());
for (int i = 1; i < fileTypes.length; i++) {
sb.append(", ");
sb.append(fileTypes[i].getTag());
}
return sb.toString();
}
/**
* @param checksum
*/
private static void printChecksum(Checksum checksum, PrintStream output) {
output.println("\tAlgorithm: "+Checksum.CHECKSUM_ALGORITHM_TO_TAG.get(checksum.getAlgorithm())+
" Value: "+checksum.getValue());
}
/**
* Prints DOAP Project information prceeded by tabs
* @param doapProject
* @param output
*/
private static void printDoapProject(DoapProject doapProject,
PrintStream output) {
if (doapProject.getName() != null && !doapProject.getName().isEmpty()) {
output.println("\tProject Name: "+doapProject.getName());
}
if (doapProject.getHomePage() != null && !doapProject.getHomePage().isEmpty()) {
output.println("\tProject Home Page: "+doapProject.getName());
}
if (doapProject.getProjectUri() != null && !doapProject.getProjectUri().isEmpty()) {
output.println("\tProject URI: "+doapProject.getProjectUri());
}
}
/**
* Print the SPDX file information with preceeding tabs
* @param spdxFile
* @param output
*/
private static void printSpdxFile(SpdxFile spdxFile, PrintStream output) {
output.println("\t"+spdxFile.getName()+", checksum:"+spdxFile.getSha1());
}
/**
* @param comparer
* @param output
*/
private static void printReviewerCompareResults(SpdxComparer comparer,
String doc1Name, String doc2Name, PrintStream output) throws SpdxCompareException, InvalidSPDXAnalysisException {
if (!comparer.isReviewersEqual()) {
SPDXReview[] inDoc1notInDoc2 = comparer.getUniqueReviewers(0, 1);
if (inDoc1notInDoc2.length > 0) {
output.println("The following Reviewer(s) are in "+doc1Name+
" but not in "+doc2Name);
for (int i = 0; i < inDoc1notInDoc2.length; i++) {
printReviewer(inDoc1notInDoc2[i], output);
}
}
SPDXReview[] inDoc2notInDoc1 = comparer.getUniqueReviewers(1, 0);
if (inDoc2notInDoc1.length > 0) {
output.println("The following Reviewer(s) are in "+doc2Name+
" but not in "+doc1Name);
for (int i = 0; i < inDoc2notInDoc1.length; i++) {
printReviewer(inDoc2notInDoc1[i], output);
}
}
SPDXReviewDifference[] differentReviewerInfo = comparer.getReviewerDifferences(0, 1);
for (int i = 0; i < differentReviewerInfo.length; i++) {
// Review date
if (!differentReviewerInfo[i].isDateEqual()) {
output.println("Date is different for the SPDX Review by "+
differentReviewerInfo[i].getReviewer()+":");
output.println("\t"+doc1Name+":"+differentReviewerInfo[i].getDate(0));
output.println("\t"+doc2Name+":"+differentReviewerInfo[i].getDate(1));
}
// Comment
if (!differentReviewerInfo[i].isCommentEqual()) {
output.println("Comment is different for the SPDX Review by "+
differentReviewerInfo[i].getReviewer()+":");
output.println("\t"+doc1Name+":"+differentReviewerInfo[i].getComment(0));
output.println("\t"+doc2Name+":"+differentReviewerInfo[i].getComment(1));
}
}
}
}
/**
* Prints an SPDX review to an output stream with preceeding tabs
* @param spdxReview
* @param output
*/
private static void printReviewer(SPDXReview spdxReview, PrintStream output) {
output.println("\tReviewer:\t"+spdxReview.getReviewer());
output.println("\tReview Date:\t"+spdxReview.getReviewDate());
if (!spdxReview.getComment().trim().isEmpty()) {
output.println("\tReview Comment:\t"+spdxReview.getComment());
}
}
/**
* @param comparer
* @param output
* @throws SpdxCompareException
*/
private static void printExtractedLicenseCompareResults(
SpdxComparer comparer, String doc1Name, String doc2Name, PrintStream output) throws SpdxCompareException {
if (!comparer.isExtractedLicensingInfosEqual()) {
ExtractedLicenseInfo[] inDoc1notInDoc2 = comparer.getUniqueExtractedLicenses(0, 1);
if (inDoc1notInDoc2 != null && inDoc1notInDoc2.length > 0) {
output.println("The following extracted licensing infos were only found in "+doc1Name);
for (int i = 0; i < inDoc1notInDoc2.length; i++) {
printSpdxLicenseInfo(inDoc1notInDoc2[i], output);
}
}
ExtractedLicenseInfo[] inDoc2notInDoc1 = comparer.getUniqueExtractedLicenses(1, 0);
if (inDoc2notInDoc1 != null && inDoc2notInDoc1.length > 0) {
output.println("The following extracted licensing infos were only found in "+doc2Name);
for (int i = 0; i < inDoc2notInDoc1.length; i++) {
printSpdxLicenseInfo(inDoc2notInDoc1[i], output);
}
}
SpdxLicenseDifference[] differentLicenses = comparer.getExtractedLicenseDifferences(0, 1);
for (int i = 0; i < differentLicenses.length; i++) {
if (!differentLicenses[i].isCommentsEqual()) {
output.println("The comments differ for the extracted license:");
if (differentLicenses[i].getCommentA() == null || differentLicenses[i].getCommentA().length() == 0) {
output.println("\tId "+differentLicenses[i].getIdA()+" in "+doc1Name+": [no comment]");
} else {
output.print("\tId "+differentLicenses[i].getIdA()+" in "+doc1Name+": ");
output.println("\""+differentLicenses[i].getCommentA()+"\"");
}
if (differentLicenses[i].getCommentB() == null || differentLicenses[i].getCommentB().length() == 0) {
output.println("\tId "+differentLicenses[i].getIdB()+" in "+doc2Name+": [no comment]");
} else {
output.print("\tId "+differentLicenses[i].getIdB()+" in "+doc2Name+": ");
output.println("\""+differentLicenses[i].getCommentB()+"\"");
}
}
if (!differentLicenses[i].isLicenseNamesEqual()) {
output.println("The license names differ for the extracted license:");
if (differentLicenses[i].getLicenseNameA() == null || differentLicenses[i].getLicenseNameA().length() == 0) {
output.println("\tId "+differentLicenses[i].getIdA()+" in "+doc1Name+": [no license name]");
} else {
output.println("\tId "+differentLicenses[i].getIdA()+" in "+doc1Name+" \""+
differentLicenses[i].getLicenseNameA()+"\"");
}
if (differentLicenses[i].getLicenseNameB() == null || differentLicenses[i].getLicenseNameB().length() == 0) {
output.println("\tId "+differentLicenses[i].getIdB()+" in "+doc2Name+": [no license name]");
} else {
output.println("\tId "+differentLicenses[i].getIdB()+" in "+doc2Name+" \""+
differentLicenses[i].getLicenseNameB()+"\"");
}
}
if (!differentLicenses[i].isSourceUrlsEqual()) {
output.println("The source URL's differ for the extracted license:");
String[] sourceUrlsA = differentLicenses[i].getSourceUrlsA();
if (sourceUrlsA == null || sourceUrlsA.length == 0) {
output.println("\tId "+differentLicenses[i].getIdA()+" in "+doc1Name+": [no source URL]");
} else {
output.println("\tId "+differentLicenses[i].getIdA()+" in "+doc1Name+" source URLs:");
for(int j = 0; j < sourceUrlsA.length; j++) {
output.println("\t\t"+sourceUrlsA[j]);
}
}
String[] sourceUrlsB = differentLicenses[i].getSourceUrlsB();
if (sourceUrlsB == null || sourceUrlsB.length == 0) {
output.println("\tId "+differentLicenses[i].getIdB()+" in "+doc2Name+": [no source URL]");
} else {
output.println("\tId "+differentLicenses[i].getIdB()+" in "+doc2Name+" source URLs:");
for(int j = 0; j < sourceUrlsB.length; j++) {
output.println("\t\t"+sourceUrlsB[j]);
}
}
}
}
}
}
/**
* Prints the nonstandard license information to the output preceeded by tabs
* @param nonStdLicense
*/
private static void printSpdxLicenseInfo(
ExtractedLicenseInfo nonStdLicense, PrintStream output) {
output.println("\tID: "+nonStdLicense.getLicenseId());
if (nonStdLicense.getComment() != null && !nonStdLicense.getComment().trim().isEmpty()) {
output.println("\tComment: "+nonStdLicense.getComment());
}
if (nonStdLicense.getName() != null && !nonStdLicense.getName().trim().isEmpty()) {
output.println("\tLicense Name: "+nonStdLicense.getName());
}
if (nonStdLicense.getSeeAlso() != null && nonStdLicense.getSeeAlso().length > 0) {
output.println("\tSource URLs:");
for (int i = 0; i < nonStdLicense.getSeeAlso().length; i++) {
output.println("\t\t"+nonStdLicense.getSeeAlso()[i]);
}
}
output.println("\tText: \""+nonStdLicense.getExtractedText()+"\"");
}
/**
* @param comparer
* @param output
* @throws SpdxCompareException
* @throws InvalidSPDXAnalysisException
*/
private static void printPackageCompareResults(SpdxComparer comparer,
String doc1Name, String doc2Name, SpdxDocument spdxDoc1, SpdxDocument spdxDoc2,
PrintStream output) throws SpdxCompareException, InvalidSPDXAnalysisException {
SpdxPackage[] uniqueA = comparer.getUniquePackages(0, 1);
if (uniqueA != null && uniqueA.length > 0) {
output.println("The following packages are in "+doc1Name+" but not in "+doc2Name+":");
for (int i = 0; i < uniqueA.length; i++) {
output.println("\t"+uniqueA[i].getName());
}
}
SpdxPackage[] uniqueB = comparer.getUniquePackages(1, 0);
if (uniqueB != null && uniqueB.length > 0) {
output.println("The following packages are in "+doc2Name+" but not in "+doc1Name+":");
for (int i = 0; i < uniqueB.length; i++) {
output.println("\t"+uniqueB[i].getName());
}
}
SpdxPackageComparer[] differences = comparer.getPackageDifferences();
if (differences != null && differences.length > 0) {
for (int i = 0; i < differences.length; i++) {
output.println("Differences were found in the package "+differences[i].getDocPackage(spdxDoc1).getName());
printPackageDifference(differences[i], doc1Name, doc2Name, spdxDoc1, spdxDoc2, output);
}
}
}
/**
* @param spdxPackageComparer
* @param doc1Name
* @param doc2Name
* @param output
* @throws SpdxCompareException
* @throws InvalidSPDXAnalysisException
*/
private static void printPackageDifference(
SpdxPackageComparer spdxPackageComparer, String doc1Name,
String doc2Name, SpdxDocument spdxDoc1, SpdxDocument spdxDoc2, PrintStream output) throws SpdxCompareException, InvalidSPDXAnalysisException {
// package version
if (!spdxPackageComparer.isPackageVersionsEquals()) {
output.println("Package versions differ.");
output.print("\t"+doc1Name+": ");
if (spdxPackageComparer.getDocPackage(spdxDoc1).getVersionInfo() != null) {
output.println(spdxPackageComparer.getDocPackage(spdxDoc1).getVersionInfo());
} else {
output.println("[none]");
}
output.print("\t"+doc2Name+": ");
if (spdxPackageComparer.getDocPackage(spdxDoc2).getVersionInfo() != null) {
output.println(spdxPackageComparer.getDocPackage(spdxDoc2).getVersionInfo());
} else {
output.println("[none]");
}
}
// package supplier
if (!spdxPackageComparer.isPackageSuppliersEquals()) {
output.println("Package supplier information differ.");
String s1 = spdxPackageComparer.getDocPackage(spdxDoc1).getSupplier();
if (s1 == null || s1.trim().isEmpty()) {
output.println("\t"+doc1Name+": [no supplier information]");
} else {
output.println("\t"+doc1Name+": "+s1);
}
String s2 = spdxPackageComparer.getDocPackage(spdxDoc2).getSupplier();
if (s2 == null || s2.trim().isEmpty()) {
output.println("\t"+doc2Name+": [no supplier information]");
} else {
output.println("\t"+doc2Name+": "+s2);
}
}
// package originator
if (!spdxPackageComparer.isPackageOriginatorsEqual()) {
output.println("Package originator information differ.");
String s1 = spdxPackageComparer.getDocPackage(spdxDoc1).getOriginator();
if (s1 == null || s1.trim().isEmpty()) {
output.println("\t"+doc1Name+": [no originator information]");
} else {
output.println("\t"+doc1Name+": "+s1);
}
String s2 = spdxPackageComparer.getDocPackage(spdxDoc2).getOriginator();
if (s2 == null || s2.trim().isEmpty()) {
output.println("\t"+doc2Name+": [no originator information]");
} else {
output.println("\t"+doc2Name+": "+s2);
}
}
// package download location
if (!spdxPackageComparer.isPackageDownloadLocationsEquals()) {
output.println("Package download locations differ.");
output.println("\t"+doc1Name+": "+spdxPackageComparer.getDocPackage(spdxDoc1).getDownloadLocation());
output.println("\t"+doc2Name+": "+spdxPackageComparer.getDocPackage(spdxDoc2).getDownloadLocation());
}
// package home page
if (!spdxPackageComparer.isPackageHomePagesEquals()) {
output.println("Package home page differ.");
if (spdxPackageComparer.getDocPackage(spdxDoc1).getHomepage() == null) {
output.println("\t"+doc1Name+": [No home page information]");
} else {
output.println("\t"+doc1Name+": "+spdxPackageComparer.getDocPackage(spdxDoc1).getHomepage());
}
if (spdxPackageComparer.getDocPackage(spdxDoc2).getHomepage() == null) {
output.println("\t"+doc2Name+": [No home page information]");
} else {
output.println("\t"+doc2Name+": "+spdxPackageComparer.getDocPackage(spdxDoc2).getHomepage());
}
}
// package verification code
if (!spdxPackageComparer.isPackageVerificationCodesEquals()) {
output.println("Package verification codees differ.");
printVerificationCode(spdxPackageComparer.getDocPackage(spdxDoc1).getPackageVerificationCode(), doc1Name, output);
printVerificationCode(spdxPackageComparer.getDocPackage(spdxDoc2).getPackageVerificationCode(), doc2Name, output);
}
// package checksum
if (!spdxPackageComparer.isPackageChecksumsEquals()) {
Checksum[] uniqueA = spdxPackageComparer.getUniqueChecksums(spdxDoc1, spdxDoc2);
if (uniqueA != null && uniqueA.length > 0) {
output.println("Checksums for package only in document "+doc1Name+":");
for (int i = 0; i < uniqueA.length; i++) {
printChecksum(uniqueA[i], output);
}
}
Checksum[] uniqueB = spdxPackageComparer.getUniqueChecksums(spdxDoc2, spdxDoc1);
if (uniqueB != null && uniqueB.length > 0) {
output.println("Checksums only in document "+doc2Name+":");
for (int i = 0; i < uniqueB.length; i++) {
printChecksum(uniqueB[i], output);
}
}
}
// source information
if (!spdxPackageComparer.isPackageSourceInfosEquals()) {
output.println("Package source information differ.");
String s1 = spdxPackageComparer.getDocPackage(spdxDoc1).getSourceInfo();
if (s1 == null || s1.trim().isEmpty()) {
output.println("\t"+doc1Name+": [no source information]");
} else {
output.println("\t"+doc1Name+": "+s1);
}
String s2 = spdxPackageComparer.getDocPackage(spdxDoc2).getSourceInfo();
if (s2 == null || s2.trim().isEmpty()) {
output.println("\t"+doc2Name+": [no source information]");
} else {
output.println("\t"+doc2Name+": "+s2);
}
}
// declared license
if (!spdxPackageComparer.isDeclaredLicensesEquals()) {
output.println("Declared licenses differ.");
output.println("\t"+doc1Name+": "+spdxPackageComparer.getDocPackage(spdxDoc1).getLicenseDeclared().toString());
output.println("\t"+doc2Name+": "+spdxPackageComparer.getDocPackage(spdxDoc2).getLicenseDeclared().toString());
}
// concluded license
if (!spdxPackageComparer.isConcludedLicenseEquals()) {
output.println("Concluded licenses differ.");
output.println("\t"+doc1Name+": "+spdxPackageComparer.getDocPackage(spdxDoc1).getLicenseConcluded().toString());
output.println("\t"+doc2Name+": "+spdxPackageComparer.getDocPackage(spdxDoc2).getLicenseConcluded().toString());
}
// all license information from files
if (!spdxPackageComparer.isSeenLicenseEquals()) {
output.println("License information from files differ.");
AnyLicenseInfo[] fromFiles1 = spdxPackageComparer.getDocPackage(spdxDoc1).getLicenseInfoFromFiles();
StringBuilder sb = new StringBuilder();
if (fromFiles1 != null && fromFiles1.length > 0) {
sb.append(Joiner.on(", ").skipNulls().join(fromFiles1));
}
output.println("\t"+doc1Name+": "+sb.toString());
sb = new StringBuilder();
AnyLicenseInfo[] fromFiles2 = spdxPackageComparer.getDocPackage(spdxDoc2).getLicenseInfoFromFiles();
if (fromFiles2 != null && fromFiles2.length > 0) {
sb.append(Joiner.on(", ").skipNulls().join(fromFiles2));
}
output.println("\t"+doc2Name+": "+sb.toString());
}
// comments on license
if (!spdxPackageComparer.isLicenseCommmentsEquals()) {
output.println("Package license comments differ.");
String s1 = spdxPackageComparer.getDocPackage(spdxDoc1).getLicenseComments();
if (s1 == null || s1.trim().isEmpty()) {
output.println("\t"+doc1Name+": [no license comments]");
} else {
output.println("\t"+doc1Name+": "+s1);
}
String s2 = spdxPackageComparer.getDocPackage(spdxDoc2).getLicenseComments();
if (s2 == null || s2.trim().isEmpty()) {
output.println("\t"+doc2Name+": [no license comments]");
} else {
output.println("\t"+doc2Name+": "+s2);
}
}
// copyright text
if (!spdxPackageComparer.isCopyrightsEquals()) {
output.println("Copyright texts differ.");
output.println("\t"+doc1Name+": "+spdxPackageComparer.getDocPackage(spdxDoc1).getCopyrightText());
output.println("\t"+doc2Name+": "+spdxPackageComparer.getDocPackage(spdxDoc2).getCopyrightText());
}
// package summary description
if (!spdxPackageComparer.isPackageSummaryEquals()) {
output.println("Package summaries differ.");
String s1 = spdxPackageComparer.getDocPackage(spdxDoc1).getSummary();
if (s1 == null || s1.trim().isEmpty()) {
output.println("\t"+doc1Name+": [no package summary]");
} else {
output.println("\t"+doc1Name+": "+s1);
}
String s2 = spdxPackageComparer.getDocPackage(spdxDoc2).getSummary();
if (s2 == null || s2.trim().isEmpty()) {
output.println("\t"+doc2Name+": [no package summary]");
} else {
output.println("\t"+doc2Name+": "+s2);
}
}
// package detailed description
if (!spdxPackageComparer.isPackageDescriptionsEquals()) {
output.println("Package detailed descriptions differ.");
String s1 = spdxPackageComparer.getDocPackage(spdxDoc1).getDescription();
if (s1 == null || s1.trim().isEmpty()) {
output.println("\t"+doc1Name+": [no package detailed description]");
} else {
output.println("\t"+doc1Name+": "+s1);
}
String s2 = spdxPackageComparer.getDocPackage(spdxDoc2).getDescription();
if (s2 == null || s2.trim().isEmpty()) {
output.println("\t"+doc2Name+": [no package detailed description]");
} else {
output.println("\t"+doc2Name+": "+s2);
}
}
// relationships
if (!spdxPackageComparer.isRelationshipsEquals()) {
Relationship[] uniqueA = spdxPackageComparer.getUniqueRelationship(spdxDoc1, spdxDoc2);
if (uniqueA != null && uniqueA.length > 0) {
output.println("The following relationships are only present in "+doc1Name+":");
for (int i = 0; i < uniqueA.length; i++) {
printRelationship(uniqueA[i], spdxPackageComparer.getDocPackage(spdxDoc1).getId(), output);
}
}
Relationship[] uniqueB = spdxPackageComparer.getUniqueRelationship(spdxDoc2, spdxDoc1);
if (uniqueB != null && uniqueB.length > 0) {
output.println("The following relationships are only present in "+doc2Name+":");
for (int i = 0; i < uniqueB.length; i++) {
printRelationship(uniqueB[i], spdxPackageComparer.getDocPackage(spdxDoc2).getId(), output);
}
}
}
// annotations
if (!spdxPackageComparer.isAnnotationsEquals()) {
Annotation[] uniqueA = spdxPackageComparer.getUniqueAnnotations(spdxDoc1, spdxDoc2);
if (uniqueA != null && uniqueA.length > 0) {
output.println("The following annotations are only present in "+doc1Name+":");
for (int i = 0; i < uniqueA.length; i++) {
printAnnotation(uniqueA[i], output);
}
}
Annotation[] uniqueB = spdxPackageComparer.getUniqueAnnotations(spdxDoc2, spdxDoc1);
if (uniqueB != null && uniqueB.length > 0) {
output.println("The following annotations are only present in "+doc2Name+":");
for (int i = 0; i < uniqueB.length; i++) {
printAnnotation(uniqueB[i], output);
}
}
}
// files
if (!spdxPackageComparer.isPackageFilesEquals()) {
if (spdxPackageComparer.getUniqueFiles(spdxDoc1, spdxDoc2).length > 0) {
output.println("The following files are only present in "+spdxPackageComparer.getDocPackage(spdxDoc1).getName()+
" in "+doc1Name+":");
for (int i = 0; i < spdxPackageComparer.getUniqueFiles(spdxDoc1, spdxDoc2).length; i++) {
output.println("\t"+spdxPackageComparer.getUniqueFiles(spdxDoc1, spdxDoc2)[i].getName());
}
}
if (spdxPackageComparer.getUniqueFiles(spdxDoc2, spdxDoc1).length > 0) {
output.println("The following files are only present in "+spdxPackageComparer.getDocPackage(spdxDoc2).getName()+
" in "+doc2Name+":");
for (int i = 0; i < spdxPackageComparer.getUniqueFiles(spdxDoc2, spdxDoc1).length; i++) {
output.println("\t"+spdxPackageComparer.getUniqueFiles(spdxDoc2, spdxDoc1)[i].getName());
}
}
if (spdxPackageComparer.getFileDifferences(spdxDoc2, spdxDoc1).length > 0) {
output.println("The following file differences were found in "+spdxPackageComparer.getDocPackage(spdxDoc2).getName());
for (int i = 0; i < spdxPackageComparer.getFileDifferences(spdxDoc2, spdxDoc1).length; i++) {
printFileDifference(spdxPackageComparer.getFileDifferences(spdxDoc2, spdxDoc1)[i], output, doc1Name, doc2Name);
}
}
}
}
/**
* Prints a verification code to output
* @param verificationCode
* @param doc1Name
*/
private static void printVerificationCode(
SpdxPackageVerificationCode verificationCode, String docName, PrintStream output) {
output.println("Verification code value for "+docName+ ": "+verificationCode.getValue());
if (verificationCode.getExcludedFileNames() != null &&
verificationCode.getExcludedFileNames().length > 0) {
output.println("The following files were excluded from the verification code for "+docName+":");
for (int i = 0; i < verificationCode.getExcludedFileNames().length; i++) {
output.println("\t"+verificationCode.getExcludedFileNames()[i]);
}
}
}
/**
* @param comparer
* @param doc1Name
* @param doc2Name
* @param output
* @throws SpdxCompareException
* @throws InvalidSPDXAnalysisException
*/
private static void printCreatorCompareResults(SpdxComparer comparer,
String doc1Name, String doc2Name, PrintStream output) throws SpdxCompareException, InvalidSPDXAnalysisException {
// creator
if (!comparer.isCreatorInformationEqual()) {
// creators
String[] inDoc1NotDoc2 = comparer.getUniqueCreators(0, 1);
if (inDoc1NotDoc2 != null && inDoc1NotDoc2.length > 0) {
output.println("The following creators are in "+doc1Name+" and not in "+doc2Name);
for (int i = 0; i < inDoc1NotDoc2.length; i++) {
output.println("\t"+inDoc1NotDoc2[i]);
}
}
String[] inDoc2NotDoc1 = comparer.getUniqueCreators(1, 0);
if (inDoc2NotDoc1 != null && inDoc2NotDoc1.length > 0) {
output.println("The following creators are in "+doc2Name+" and not in "+doc1Name);
for (int i = 0; i < inDoc2NotDoc1.length; i++) {
output.println("\t"+inDoc2NotDoc1[i]);
}
}
SPDXCreatorInformation doc1CreatorInfo = comparer.getSpdxDoc(0).getCreationInfo();
SPDXCreatorInformation doc2CreatorInfo = comparer.getSpdxDoc(1).getCreationInfo();
// created
if (!SpdxComparer.stringsEqual(doc1CreatorInfo.getCreated(), doc2CreatorInfo.getCreated())) {
output.println("Creator creation dates differ.");
if (doc1CreatorInfo.getCreated() == null) {
output.println("\t"+doc1Name+": No creation date");
} else {
output.println("\t"+doc1Name+": "+doc1CreatorInfo.getCreated());
}
if (doc2CreatorInfo.getCreated() == null) {
output.println("\t"+doc2Name+": No creation date");
} else {
output.println("\t"+doc2Name+": "+doc2CreatorInfo.getCreated());
}
}
// creator comments
if (!SpdxComparer.stringsEqual(doc1CreatorInfo.getComment(),doc2CreatorInfo.getComment())) {
output.println("Creator comments differ.");
if (doc1CreatorInfo.getComment() == null) {
output.println("\t"+doc1Name+": [No comment]");
} else {
output.println("\t"+doc1Name+": "+doc1CreatorInfo.getComment());
}
if (doc2CreatorInfo.getComment() == null) {
output.println("\t"+doc2Name+": [No comment]");
} else {
output.println("\t"+doc2Name+": "+doc2CreatorInfo.getComment());
}
}
// license list version
if (!SpdxComparer.stringsEqual(doc1CreatorInfo.getLicenseListVersion(), doc2CreatorInfo.getLicenseListVersion())) {
output.println("License list versions differ.");
if (doc1CreatorInfo.getLicenseListVersion() == null) {
output.println("\t"+doc1Name+": [No license list version]");
} else {
output.println("\t"+doc1Name+": "+doc1CreatorInfo.getLicenseListVersion());
}
if (doc2CreatorInfo.getLicenseListVersion() == null) {
output.println("\t"+doc2Name+": [No license list version]");
} else {
output.println("\t"+doc2Name+": "+doc2CreatorInfo.getLicenseListVersion());
}
}
}
}
/**
* @param spdxDocFileName File name of either an RDF or Tag formated SPDX file
* @return
*/
protected static SpdxDocument openRdfOrTagDoc(String spdxDocFileName, List warnings) throws SpdxCompareException {
File spdxDocFile = new File(spdxDocFileName);
if (!spdxDocFile.exists()) {
throw(new SpdxCompareException("SPDX File "+spdxDocFileName+" does not exist."));
}
if (!spdxDocFile.canRead()) {
throw(new SpdxCompareException("SPDX File "+spdxDocFileName+" can not be read."));
}
SpdxDocument retval = null;
String errorDetails1 = "(no error details available)";
String errorDetails2 = "(no error details available)";
try {
// Try to open the file as a tag/value file first.
retval = convertTagValueToRdf(spdxDocFile, warnings);
logger.info("Document identified as SPDX tag/value.");
} catch (SpdxCompareException e) {
// For invalid Tag/value files
errorDetails1 = e.getMessage();
throw(new SpdxCompareException("File "+spdxDocFileName+" is not a recognized RDF/XML or tag/value format: " + errorDetails1));
} catch (Exception e){
// Ignore - assume this is an RDF/XML file.
errorDetails1 = e.getMessage();
}
if (retval == null) {
try {
// Now try to open the file as an RDF/XML file.
retval = SPDXDocumentFactory.createSpdxDocument(spdxDocFileName);
logger.info("Document identified as SPDX RDF/XML.");
} catch (IOException e) {
errorDetails2 = e.getMessage();
// Ignore - unrecognized files are handled below.
} catch (InvalidSPDXAnalysisException e) {
errorDetails2 = e.getMessage();
// Ignore - unrecognized files are handled below.
} catch (Exception e) {
errorDetails2 = e.getMessage();
// Ignore - unrecognized files are handled below.
}
}
if (retval == null) {
throw(new SpdxCompareException("File "+spdxDocFileName+" is not a recognized RDF/XML or tag/value format. While verifying for Tag/Value format: " + errorDetails1 + ". While verifying for RDF/XML format: "+ errorDetails2 ));
}
return retval;
}
/**
* Converts a tag/value file to an rdfFile
* @param tagValueFile Input file in tag/value format
* @param tempRdfFile File to output the generated RDF file (must already exist - file is overwritten)
*/
protected static SpdxDocument convertTagValueToRdf(File tagValueFile, List warnings) throws SpdxCompareException,Exception {
FileInputStream in = null;
try {
in = new FileInputStream(tagValueFile);
SpdxDocument result = TagToRDF.convertTagFileToRdf(in, TagToRDF.DEFAULT_OUTPUT_FORMAT, warnings).getSpdxDocument();
return result;
}
catch (InvalidSpdxTagFileException e){
// error in tag value file
throw(new SpdxCompareException(e.getMessage(),e));
}
catch (InvalidFileFormatException e){
// Ignore - invalid file format or RDF/XML file
throw(new Exception(e.getMessage(),e));
}
catch (Exception e) {
// Ignore - assume this is an RDF/XML file.
throw(new Exception("Error converting tag/value to RDF/XML format: "+e.getMessage(),e));
} finally {
if (in != null) {
try {
in.close();
} catch (IOException e) {
System.out.println("Error closing Tag/Value file: " + e.getMessage());
}
}
}
}
private static void usage() {
System.out.println("Usage: CompareSpdxDoc doc1 doc2 [output]");
System.out.println("where doc1 and doc2 are file names of valid SPDX documents ");
System.out.println("in either tag/value or RDF/XML format");
System.out.println("and [output] is an optional output text file name");
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy