| /******************************************************************************* |
| * Copyright (c) 2014 Obeo and others. |
| * 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: |
| * Obeo - initial API and implementation |
| * E.D.Willink (CEA LIST) - 425799 Validity View Integration |
| *******************************************************************************/ |
| package org.eclipse.ocl.examples.validity.test; |
| |
| import java.io.FileWriter; |
| import java.io.IOException; |
| import java.io.StringReader; |
| import java.util.Scanner; |
| |
| import javax.xml.xpath.XPathExpressionException; |
| |
| import org.eclipse.core.runtime.CoreException; |
| import org.eclipse.jdt.annotation.NonNull; |
| import org.eclipse.ocl.examples.emf.validation.validity.Result; |
| import org.eclipse.ocl.examples.emf.validation.validity.Severity; |
| import org.eclipse.ocl.examples.emf.validation.validity.export.TextExporter; |
| import org.junit.After; |
| import org.junit.Before; |
| import org.junit.Test; |
| |
| /** |
| * Class testing the TextExport class. |
| */ |
| public class TextExportOCLValidationResultTests extends AbstractExportOCLValidationResultTests |
| { |
| private static final int WARNING_NUMBER_XPATH_LOCATION = 15; |
| private static final int INFO_NUMBER_XPATH_LOCATION = 14; |
| private static final int ERROR_NUMBER_XPATH_LOCATION = 16; |
| private static final int FAILURE_NUMBER_XPATH_LOCATION = 17; |
| private static final int SUCCESS_NUMBER_XPATH_LOCATION = 13; |
| |
| private String exportedFileName = null; |
| |
| protected void assertLineContains(@NonNull String contents, int lineNumber, String expression) throws CoreException, IOException { |
| Scanner sc = new Scanner(new StringReader(contents)); |
| String line = null; |
| int i = 1; |
| while (i <= lineNumber) { |
| line = sc.nextLine(); |
| i++; |
| } |
| if (line != null) { |
| assertTrue("Expected \"" + line + "\" to contain \"" + expression + "\"", line.contains(expression)); |
| } |
| sc.close(); |
| } |
| |
| protected @NonNull String doTest() throws IOException { |
| String exported = exporter.export(ecoreResource, rootNode, exportedFileName); |
| FileWriter writer = new FileWriter(exportedFileName); |
| writer.append(exported); |
| writer.close(); |
| TEST_PROGRESS.println("exported " + ecoreResource.getURI()); |
| return exported; |
| } |
| |
| @Before |
| public void setUp() throws Exception { |
| super.setUp(); |
| exportedFileName = getProjectFileName(getName() + ".txt"); |
| initExporter(TextExporter.EXPORTER_TYPE); |
| } |
| |
| @After |
| public void tearDown() throws Exception { |
| super.tearDown(); |
| } |
| |
| /** |
| * |
| * Tests that the exported file contains the expected log for metrics |
| * section. |
| * |
| * @throws IOException |
| * @throws XPathExpressionException |
| * @throws CoreException |
| */ |
| @Test |
| public void testTEXTExport_LoggingMetricsWithNoSeverity() |
| throws IOException, XPathExpressionException, CoreException { |
| // initiate the test case |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE5_E_STRING) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.OK); |
| |
| // launch the exporter |
| String exported = doTest(); |
| |
| // test the exporteFile content |
| assertLineContains(exported, SUCCESS_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| assertLineContains(exported, INFO_NUMBER_XPATH_LOCATION, "0"); //$NON-NLS-1$ |
| assertLineContains(exported, WARNING_NUMBER_XPATH_LOCATION, "0"); //$NON-NLS-1$ |
| assertLineContains(exported, ERROR_NUMBER_XPATH_LOCATION, "0"); //$NON-NLS-1$ |
| assertLineContains(exported, FAILURE_NUMBER_XPATH_LOCATION, "0"); //$NON-NLS-1$ |
| } |
| |
| /** |
| * Tests that the exported file contains the expected log for metrics |
| * section. |
| * |
| * @throws IOException |
| * @throws XPathExpressionException |
| * @throws CoreException |
| */ |
| @Test |
| public void testTEXTExport_LoggingMetricsWithInformationSeverity() |
| throws IOException, XPathExpressionException, CoreException { |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE5_E_STRING) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.OK); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE3_E_SHORT) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.INFO); |
| |
| // launch the exporter |
| String exported = doTest(); |
| |
| assertLineContains(exported, SUCCESS_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| assertLineContains(exported, INFO_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| assertLineContains(exported, WARNING_NUMBER_XPATH_LOCATION, "0"); //$NON-NLS-1$ |
| assertLineContains(exported, ERROR_NUMBER_XPATH_LOCATION, "0"); //$NON-NLS-1$ |
| assertLineContains(exported, FAILURE_NUMBER_XPATH_LOCATION, "0"); //$NON-NLS-1$ |
| } |
| |
| /** |
| * Tests that the exported file contains the expected log for metrics |
| * section. |
| * |
| * @throws IOException |
| * @throws XPathExpressionException |
| * @throws CoreException |
| */ |
| @Test |
| public void testTEXTExport_LoggingMetricsWithWarningSeverity() |
| throws IOException, InterruptedException, XPathExpressionException, |
| CoreException { |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE5_E_STRING) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.OK); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE3_E_SHORT) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.INFO); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE1_E_STRING) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.WARNING); |
| |
| // launch the exporter |
| String exported = doTest(); |
| |
| assertLineContains(exported, SUCCESS_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| assertLineContains(exported, INFO_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| assertLineContains(exported, WARNING_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| assertLineContains(exported, ERROR_NUMBER_XPATH_LOCATION, "0"); //$NON-NLS-1$ |
| assertLineContains(exported, FAILURE_NUMBER_XPATH_LOCATION, "0"); //$NON-NLS-1$ |
| } |
| |
| /** |
| * Tests that the exported file contains the expected log for metrics |
| * section. |
| * |
| * @throws IOException |
| * @throws XPathExpressionException |
| * @throws CoreException |
| */ |
| @Test |
| public void testTEXTExport_LoggingMetricsWithErrorSeverity() |
| throws IOException, InterruptedException, XPathExpressionException, |
| CoreException { |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE5_E_STRING) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.OK); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE3_E_SHORT) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.INFO); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE1_E_STRING) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.WARNING); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE2_E_STRING) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.ERROR); |
| |
| // launch the exporter |
| String exported = doTest(); |
| |
| assertLineContains(exported, SUCCESS_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| assertLineContains(exported, INFO_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| assertLineContains(exported, WARNING_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| assertLineContains(exported, ERROR_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| assertLineContains(exported, FAILURE_NUMBER_XPATH_LOCATION, "0"); //$NON-NLS-1$ |
| } |
| |
| /** |
| * Tests that the exported file contains the expected log for metrics |
| * section. |
| * |
| * @throws IOException |
| * @throws XPathExpressionException |
| * @throws CoreException |
| */ |
| @Test |
| public void testTEXTExport_LoggingMetricsWithFailureSeverity() |
| throws IOException, InterruptedException, XPathExpressionException, |
| CoreException { |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE5_E_STRING) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.OK); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE3_E_SHORT) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.INFO); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE1_E_STRING) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.WARNING); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE2_E_STRING) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.ERROR); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE4_E_STRING) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.FATAL); |
| |
| // launch the exporter |
| String exported = doTest(); |
| |
| assertLineContains(exported, SUCCESS_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| assertLineContains(exported, INFO_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| assertLineContains(exported, WARNING_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| assertLineContains(exported, ERROR_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| assertLineContains(exported, FAILURE_NUMBER_XPATH_LOCATION, "1"); //$NON-NLS-1$ |
| } |
| |
| /** |
| * Tests that the exported content contains the expected diagnostics for a |
| * constraint. |
| * |
| * @throws XPathExpressionException |
| * @throws CoreException |
| * @throws IOException |
| */ |
| public void testTEXTExport_LogNullDiagnosticMessage() |
| throws XPathExpressionException, CoreException, IOException { |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE3_E_SHORT) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.INFO); |
| |
| // launch the exporter |
| String exported = doTest(); |
| |
| assertLineContains(exported, 26, "null diagnostic message"); //$NON-NLS-1$ |
| } |
| |
| /** |
| * Tests that the exported content contains the expected diagnostics for a |
| * constraint. |
| * |
| * @throws XPathExpressionException |
| * @throws CoreException |
| * @throws IOException |
| */ |
| @Test |
| public void testTEXTExport_LogInfoDiagnosticMessage() throws IOException, |
| InterruptedException, XPathExpressionException, CoreException { |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE3_E_SHORT) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.INFO); |
| // exporter.export(TestTool.getIResource(ecoreResource), rootNode, GENERATED_FILE_PATH); |
| // assertLineContains(exported, 26, "null diagnostic message"); //$NON-NLS-1$ |
| |
| // clearGeneratedReport(); |
| String diagnostic = "Diag INFO"; //$NON-NLS-1$ |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE3_E_SHORT) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setDiagnostic(diagnostic); |
| |
| // launch the exporter |
| String exported = doTest(); |
| |
| assertLineContains(exported, 26, diagnostic); |
| } |
| |
| @Test |
| public void testTEXTExport_ProducesAllLogHeadings() throws IOException, |
| CoreException { |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_ECLASS1_CONSTRAINT, VALIDATABLE_ECLASS1_E1_ATT1).setSeverity( //$NON-NLS-1$ //$NON-NLS-2$ |
| Severity.ERROR); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EPACKAGE_CONSTRAINT, VALIDATABLE_ECORE_TEST).setSeverity( //$NON-NLS-1$ //$NON-NLS-2$ |
| Severity.FATAL); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE3_E_SHORT) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.WARNING); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_ECLASS2_CONSTRAINT, VALIDATABLE_E_CLASS2).setSeverity( //$NON-NLS-1$ //$NON-NLS-2$ |
| Severity.INFO); |
| |
| // launch the exporter |
| String exported = doTest(); |
| |
| // test tables headings |
| assertLineContains(exported, 22, "ecoreTest.ocl"); //$NON-NLS-1$ |
| assertLineContains(exported, 23, "eclass2_constraint"); //$NON-NLS-1$ |
| assertLineContains(exported, 24, "eclass2_constraint"); //$NON-NLS-1$ |
| assertLineContains(exported, 25, "INFO"); //$NON-NLS-1$ |
| |
| assertLineContains(exported, 29, "ecore.ocl"); //$NON-NLS-1$ |
| assertLineContains(exported, 30, "eattribute_constraint"); //$NON-NLS-1$ |
| assertLineContains(exported, 31, "eattribute_constraint"); //$NON-NLS-1$ |
| assertLineContains(exported, 32, "WARNING"); //$NON-NLS-1$ |
| |
| assertLineContains(exported, 36, "ecoreTest.ocl"); //$NON-NLS-1$ |
| assertLineContains(exported, 37, "eclass1_constraint"); //$NON-NLS-1$ |
| assertLineContains(exported, 38, "eclass1_constraint"); //$NON-NLS-1$ |
| assertLineContains(exported, 39, "ERROR"); //$NON-NLS-1$ |
| |
| assertLineContains(exported, 43, "ecore.ocl"); //$NON-NLS-1$ |
| assertLineContains(exported, 44, "epackage_constraint"); //$NON-NLS-1$ |
| assertLineContains(exported, 45, "epackage_constraint"); //$NON-NLS-1$ |
| assertLineContains(exported, 46, "FATAL"); //$NON-NLS-1$ |
| } |
| |
| @Test |
| public void testTEXTExport_Statistics() throws IOException, CoreException { |
| for (Result result : results) { |
| result.setSeverity(Severity.OK); |
| } |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_ECLASS1_CONSTRAINT, VALIDATABLE_ECLASS1_E1_ATT1).setSeverity( //$NON-NLS-1$ //$NON-NLS-2$ |
| Severity.ERROR); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EPACKAGE_CONSTRAINT_2, VALIDATABLE_ECORE_TEST).setSeverity( //$NON-NLS-1$ //$NON-NLS-2$ |
| Severity.ERROR); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EPACKAGE_CONSTRAINT, VALIDATABLE_ECORE_TEST).setSeverity( //$NON-NLS-1$ //$NON-NLS-2$ |
| Severity.FATAL); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_ECLASS_CONSTRAINT, VALIDATABLE_E_CLASS3_ECLASS5) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.FATAL); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE3_E_SHORT) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.WARNING); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_ECLASS2_CONSTRAINT, VALIDATABLE_E_CLASS2).setSeverity( //$NON-NLS-1$ //$NON-NLS-2$ |
| Severity.INFO); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE5_E_STRING) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.INFO); |
| getResultOfValidatableNodeFromLabel(results, |
| CONSTRAINABLE_EATTRIBUTE_CONSTRAINT, VALIDATABLE_E_ATTRIBUTE1_E_STRING) //$NON-NLS-1$ //$NON-NLS-2$ |
| .setSeverity(Severity.WARNING); |
| |
| // launch the exporter |
| String exported = doTest(); |
| |
| // tests validation results |
| // Total number |
| assertLineContains(exported, 12, EXPECTED_RESULTS.toString()); //$NON-NLS-1$ |
| |
| // Success |
| assertLineContains(exported, 13, EXPECTED_SUCCESSES.toString()); //$NON-NLS-1$ |
| |
| // Infos |
| assertLineContains(exported, 14, EXPECTED_INFOS.toString()); //$NON-NLS-1$ |
| |
| // Warning |
| assertLineContains(exported, 15, EXPECTED_WARNINGS.toString()); //$NON-NLS-1$ |
| |
| // Errors |
| assertLineContains(exported, 16, EXPECTED_ERRORS.toString()); //$NON-NLS-1$ |
| |
| // Failures |
| assertLineContains(exported, 17, EXPECTED_FAILURES.toString()); //$NON-NLS-1$ |
| } |
| |
| @Test |
| public void testTEXTExport_ModelsValidatedSuccessfully() throws IOException, CoreException { |
| // launch the exporter |
| String exported = doTest(); |
| |
| // test output file name |
| assertLineContains(exported, 2, exportedFileName); |
| |
| // test resource validated |
| assertLineContains(exported, 8, "ecoreTest.ecore"); //$NON-NLS-1$ |
| |
| // tests validation results |
| // Total number |
| assertLineContains(exported, 12, "0"); //$NON-NLS-1$ |
| |
| // Success |
| assertLineContains(exported, 13, "0"); //$NON-NLS-1$ |
| |
| // Infos |
| assertLineContains(exported, 14, "0"); //$NON-NLS-1$ |
| |
| // Warning |
| assertLineContains(exported, 15, "0"); //$NON-NLS-1$ |
| |
| // Errors |
| assertLineContains(exported, 16, "0"); //$NON-NLS-1$ |
| |
| // Failures |
| assertLineContains(exported, 17, "0"); //$NON-NLS-1$ |
| |
| // test logs results |
| assertLineContains(exported, 21, "No log to display: models has been successfully validated."); //$NON-NLS-1$ |
| } |
| |
| } |
