How to use files for validation from the test/resources folder during tests?

Question

Background: I want to validate XML-files against a schema automatically. For this I created a maven-project and a XMLValidator-class in src/main/java.

To run the tests I created a XMLValidatorTest in src/test/java. My idea was to put the XML and XSD files, I want to validate, into the src/test/resources folder and "grab" them by their filename. But when I run mvn test the files are not found.

My test-class:

public class XMLValidatorTest {

  XMLValidator xmlvalidator;

  // XSD is in src\test\resources\XSD\myXSD.xsd
  String xsdFileNameWithPath = "XSD\\myXSD.xsd";

  @Before
  public void setup() {
    xmlvalidator = new XMLValidator();
  }

  @Test
  public void testValidate() {

    // XML is in src\test\resources\XML\test001.xml
    String xmlFileNameWithPath = "XML\\test001.xml";


    assertTrue(xmlvalidator.validate(xmlFileNameWithPath, xsdFileNameWithPath));
  } 
}

When I run mvn test I get a file not found exception for e.g. java.io.FileNotFoundException: D:\workspace_eclipse\XSDTester\XSD\myXSD.xsd - which is right as it's in the resource folder.

I tried the solution from Maven (surefire): copy test resources from src/test/java by copying the files via a <testresources>-tag but it has no effect.

<build>
  <testResources>
    <testResource>
      <directory>${project.basedir}/src/test/resources</directory>
    </testResource>
  </testResources>
</build>

Any advise?

P.S. In my XMLValidator I try to use the given files via:

Source xmlFile = new StreamSource(new File(xmlFileNameWithPath));
Source xsdFile = new StreamSource(new File(xsdFileNameWithPath));

edit

I'm again trying to implement Michele Sacchetti advise using a this.getClass().getResourceAsStream().

So to retrieve the XML file I try this

validate (String xmlFileNameWithPath, String xsdFileNameWithPath) {

  Source xmlFile;
  try {
    // give systemid according to: https://stackoverflow.com/questions/10997453/java-xml-validation-does-not-work-when-schema-comes-from-classpath
    xmlFile = new StreamSource(getClass().getResourceAsStream(xmlFileNameWithPath), getClass().getResource(xsdFileNameWithPath).toString());
  } catch (Exception e) {
    System.out.println("XML is null");
    return false;   
  } 

  // ...  further steps, trying to get the XSD and validate them
}

and call the function via (as Michele Sacchetti said with omiting src\test\resources)

// XSD is in src\test\resources\XSD\myXSD.xsd
String xsdFileNameWithPath = "XSD\\myXSD.xsd";

// XML is in src\test\resources\XML\test001.xml
String xmlFileNameWithPath = "XML\\test001.xml";

validate(xmlFileNameWithPath, xsdFileNameWithPath);

But I always get a NPE then trying to get the StreamSource for the file.

Answer 1

Do not try to access files through filename but use this.getClass().getResourceAsStream() method to access them via CLASSPATH (you must omit starting /src/test/resources)

in the sample bleow file is under

src/test/resources/test/test.properties

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>test</groupId>
  <artifactId>test</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>test</name>
  <dependencies>
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.10</version>
        <type>jar</type>
        <scope>test</scope>
    </dependency>
  </dependencies>
</project>

Test source

package test;

import java.io.IOException;
import java.net.URISyntaxException;
import org.junit.Test;

public class ReadFileTest {


    @Test
    public void readTest() throws IOException, URISyntaxException{
        System.out.println(ReadFileTest.class.getResource("test.properties").toURI());
    }

}

mvn clean test output

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building test 0.0.1-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ test ---
[WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] Copying 0 resource
[INFO] 
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ test ---
[INFO] Nothing to compile - all classes are up to date
[INFO] 
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ test ---
[WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] Copying 1 resource
[INFO] 
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ test ---
[INFO] Nothing to compile - all classes are up to date
[INFO] 
[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ test ---
[INFO] Surefire report directory: /Users/msacchetti/fworks/oss_projects/test/target/surefire-reports

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running test.ReadFileTest
file:/Users/msacchetti/fworks/oss_projects/test/target/test-classes/test/test.properties
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.037 sec

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1.318 s
[INFO] Finished at: 2016-04-26T21:36:54+02:00
[INFO] Final Memory: 10M/245M
[INFO] ------------------------------------------------------------------------

note that the returning path is correctly into the target folder and not in src one