org.spdx.tools.Verify Maven / Gradle / Ivy

/**
 * Copyright (c) 2015 Source Auditor 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.IOException;
import java.util.ArrayList;
import java.util.List;

import org.spdx.compare.SpdxCompareException;
import org.spdx.rdfparser.InvalidSPDXAnalysisException;
import org.spdx.rdfparser.SPDXDocumentFactory;
import org.spdx.rdfparser.model.SpdxDocument;

/**
 * Verifies an SPDX document and lists any verification errors
 * @author Gary O'Neall
 *
 */
public class Verify {
	
	static final int MIN_ARGS = 1;
	static final int MAX_ARGS = 1;
	static final int ERROR_STATUS = 1;

	/**
	 * @param args Single argument SPDX file - can be tag/value or RDF
	 */
	public static void main(String[] args) {
		if (args.length < MIN_ARGS) {
			System.err
					.println("Usage:\n Verify file\nwhere file is the file path to an SPDX RDF XML or an SPDX Tag/Value file");
			System.exit(ERROR_STATUS);
		}
		if (args.length > MAX_ARGS) {
			System.out.printf("Warning: Extra arguments will be ignored");
		}
		List verify = null;
		try {
			verify = verify(args[0]);
		} catch (SpdxVerificationException e) {
			System.out.println(e.getMessage());
			System.exit(ERROR_STATUS);
		}
		if (verify.size() > 0) {
			System.out.println("This SPDX Document is not valid due to:");
			for (int i = 0; i < verify.size(); i++) {
				System.out.print("\t" + verify.get(i)+"\n");
			}
			System.exit(ERROR_STATUS);
		} else {
			System.out.println("This SPDX Document is valid.");
		}
	}
	
	/**
	 * Verify a tag/value or SPDX file
	 * @param filePath File path to the SPDX file to be verified
	 * @return A list of verification errors - if empty, the SPDX file is valid
	 * @throws Errors where the SPDX file can not be parsed or the filename is invalid
	 */
	public static List verify(String filePath) throws SpdxVerificationException {
		SpdxDocument doc = null;
		List parserWarnings = new ArrayList();
		try {
			doc = CompareSpdxDocs.openRdfOrTagDoc(filePath, parserWarnings);
		} catch (SpdxCompareException e) {
			throw new SpdxVerificationException("Unable to parse the file: "+e.getMessage(),e);
		}
		List verify = doc.verify();
		List retval = new ArrayList();
		if (!verify.isEmpty()) {
			retval.addAll(parserWarnings);
			for (String verifyMsg:verify) {	
				// Add any un-duplicated warnings and errors
				boolean found = false;
				for (String parserWarning:parserWarnings) {
					if (parserWarning.contains(verifyMsg)) {
						found = true;
						break;
					}
				}
				if (!found) {
					retval.add(verifyMsg);
				}
			}
		}
		return retval;		
	}
	
	/**
	 * Verify a tag/value file
	 * @param filePath File path to the SPDX Tag Value file to be verified
	 * @return A list of verification errors - if empty, the SPDX file is valid
	 * @throws SpdxVerificationException Errors where the SPDX Tag Value file can not be parsed or the filename is invalid
	 */
	public static List verifyTagFile(String filePath) throws SpdxVerificationException {
		SpdxDocument doc = null;
		List parserWarnings = new ArrayList();
		File spdxDocFile = new File(filePath);
		if (!spdxDocFile.exists()) {
			throw(new SpdxVerificationException("SPDX File "+filePath+" does not exist."));
		}
		if (!spdxDocFile.canRead()) {
			throw(new SpdxVerificationException("SPDX File "+filePath+" can not be read."));
		}
		try {
			// Try to open the tag value file
			doc = CompareSpdxDocs.convertTagValueToRdf(spdxDocFile, parserWarnings);
		} catch (SpdxCompareException e) {
			throw new SpdxVerificationException("Unable to parse the file: "+e.getMessage(),e);
		} catch (Exception e) {
			throw new SpdxVerificationException("Not a valid SPDX Tag Value File Format.");
		}
		List verify = doc.verify();
		List retval = new ArrayList();
		if (!verify.isEmpty()) {
			retval.addAll(parserWarnings);
			for (String verifyMsg:verify) {	
				// Add any un-duplicated warnings and errors
				boolean found = false;
				for (String parserWarning:parserWarnings) {
					if (parserWarning.contains(verifyMsg)) {
						found = true;
						break;
					}
				}
				if (!found) {
					retval.add(verifyMsg);
				}
			}
		}
		return retval;		
	}
	
	/**
	 * Verify an RDF/XML file
	 * @param filePath File path to the SPDX RDF/XML file to be verified
	 * @return SpdxDocument 
	 * @throws SpdxVerificationException Errors where the SPDX RDF/XML file can not be parsed or the filename is invalid
	 */
	public static List verifyRDFFile(String filePath) throws SpdxVerificationException {
		SpdxDocument doc = null;
		File spdxDocFile = new File(filePath);
		// Check whether file exists and can be read
		if (!spdxDocFile.exists()) {
			throw(new SpdxVerificationException("SPDX File "+filePath+" does not exist."));
		}
		if (!spdxDocFile.canRead()) {
			throw(new SpdxVerificationException("SPDX File "+filePath+" can not be read."));
		}
		try {
			// Try to open the file as an RDF/XML file.
			doc = SPDXDocumentFactory.createSpdxDocument(filePath);
		} catch (IOException e) {
			throw new SpdxVerificationException("Unable to parse the file: "+e.getMessage(),e);
		} catch (InvalidSPDXAnalysisException e) {
			throw new SpdxVerificationException("Unable to parse the file: "+e.getMessage(),e);
		} catch (Exception e) {
			throw new SpdxVerificationException("Unable to parse the file: "+e.getMessage(),e);
		}
		List retval = doc.verify();
		return retval;		
	}
}