Junit + getResourceAsStream Returning Null

Question

Not sure how this is possible. I re-read up on getResourceAsStream and it's always returning null.

InputStream source = this.getClass().getResourceAsStream("test.xml");

Right next to test.java in the Finder (using OS X and Eclipse) is test.xml

I can open it in TextWrangler and view it as existing with data inside.

This is a Junit test if it makes any difference. I went and looked at existing Junit tests on our system and I'm using it in the exactly same manner as a working example (as in where the file is located and the code itself).

What small difference could there be preventing I assume getClass() from returning the right path?

score 31 · Answer 1 · answered Jun 30 '11 at 21:12

31

It's not finding the resource on the classpath. If you are using junit and maven make sure the resources are copied on the target/test-classes by adding <include> file directive on <testResource> section

You can also find out the location of your class in the file system by using

this.getClass().getResource(".")

and checking to see if the resource is there

answered Jun 30 '11 at 21:12

surajz

3,446
3
29
37

9

`System.out.println(MyClass.class.getResource(".").getPath());` – jcalfee314 Jun 25 '13 at 20:10
4

System.out.println(this.getClass().getClassLoader().getResource(".").getPath()); – pherris Dec 12 '13 at 22:15
1

Yeah this helped! I could see what the folder was where things were being compiled, then I searched through that folder on the command line to see where my resources was, and loaded it relative to that.... Thanks! – Brad Parks May 19 '20 at 14:56

score 25 · Accepted Answer · answered Mar 08 '11 at 20:44

25

getResourceAsStream() is using the CLASSPATH, and as such it will load from wherever your classes are, not your source files.

I suspect you need to copy your XML to the same directory as your .class file.

answered Mar 08 '11 at 20:44

Brian Agnew

261,477
36
323
432

score 23 · Answer 3 · answered Mar 26 '15 at 13:45

23

In case you are using Maven, add this part to your pom.xml

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

Your test.xml and other resource files must be located in src/test/resources

answered Mar 26 '15 at 13:45

humkins

8,358
10
53
68

1

This was very helpful. Thanks! – Vinayak Ponangi Jun 24 '15 at 23:38
1

Does this copy src/main/resources to a location where test files can access them? This directory is the default for test resources already... so I'm not sure why it needs to be specified? – TheJeff Oct 12 '20 at 14:21

score 12 · Answer 4 · answered Mar 08 '11 at 21:12

I always have problem with this method. Here are 2 links, which might be useful:

I always experiment with adding "/" at the beginning or "./".

From my experience the best method is using FileInputStream. There is only one thing to remember (while using FileInputStream with Eclipse), with default settings, your working directory is set to projects root. You can always check where is your current directory (and what relative paths you need)using this piece of code.

Like -> I always experiment with adding "/" at the beginning or "./". — Dhana Krishnasamy, Oct 16 '15 at 15:35

score 9 · Answer 5 · answered Mar 08 '11 at 21:51

9

Assuming test.xml is located right under your test root source folder, do this:-

InputStream source = this.getClass().getClassLoader().getResourceAsStream("test.xml");

answered Mar 08 '11 at 21:51

limc

38,266
19
97
142

score 3 · Answer 6 · answered Dec 21 '17 at 19:21

3

I spent lot of time in this problem and it was missing me the following configuration: Right-click on an eclipse project and select Properties -> Java Build Path -> Source and edit Included row and add *.properties (*.fileExtension)

answered Dec 21 '17 at 19:21

egroque

57
5

score 2 · Answer 7 · answered Oct 23 '19 at 05:49

2

Put test.xml in the src/main/resources (or src/test/resources).

File file = ResourceUtils.getFile("classpath:test.xml");
String test = new String(Files.readAllBytes(file.toPath()));

answered Oct 23 '19 at 05:49

Stuart McIntyre

872
6
8

score 2 · Answer 8 · answered Mar 02 '20 at 11:00

2

try using classloader

InputStream source = this.getClass().getClassLoader().getResourceAsStream("test.xml");

answered Mar 02 '20 at 11:00

Bandikatla Sai charan

59
6

Prepending `classpath:` to the path was crucial for me, so `"classpath:/test.xml"` – isgoed Jan 21 '21 at 15:38

score 0 · Answer 9 · answered Jun 12 '13 at 09:10

From Java API:

http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html#getSystemResource(java.lang.String)

Find a resource of the specified name from the search path used to load classes. This method locates the resource through the system class loader

So the syntax will for instance be: ClassLoader.getSystemResource("test.xml").toString();

Works like a charm!

score 0 · Answer 10 · answered Mar 08 '11 at 21:10

0

Try MyClass.getResourceAsStream().

Also try putting the test.xml in your classpath. For instance, in an Eclipse web project put text.xml in webcontent/WEB-INF/classes

answered Mar 08 '11 at 21:10

Paul Croarkin

14,110
14
78
114

score -1 · Answer 11 · answered Jul 26 '17 at 07:23

You need to put the copy of your resource file to the test resources, in my example it is font file:

Then call next from your jUnit test:

 public static InputStream getFontAsStream() throws IOException {
        return Thread.currentThread().getContextClassLoader()
                    .getResourceAsStream("fonts/" + "FreeSans.ttf");
    }

score -1 · Answer 12 · answered Feb 09 '12 at 00:21

-1

Add the folder that your having your resource files in to the source folders of eclipse. Then the file should be automatically put in the bin directory.

answered Feb 09 '12 at 00:21

Benedikt

1

score -2 · Answer 13 · answered Nov 11 '16 at 23:12

I had this problem with a Spring class. System.class.getResourceAsStream(...) worked in unit tests but not in Tomcat, Thread.currentThread().getContextClassLoader().getResourceAsStream(...) worked in Tomcat but not in unit tests.

Ulitimately I went with:

ClassUtils.getDefaultClassLoader()
    .getResourceAsStream("com/example/mail/templates/invoice-past-due.html"))

I also found that once I did it this way, I did not need to have the path starting with a slash.

Where did you get ClassUtils from? – Yeikel Oct 13 '21 at 21:04 — Yeikel, Oct 13 '21 at 21:04

Junit + getResourceAsStream Returning Null

13 Answers13

Linked