Maven Surefire

Maven surefire plugin creates two surefire* directories in the ${project.build.directory}

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: 2.12
  • Fix Version/s: 2.12.2
  • Component/s: Maven Surefire Plugin
  • Labels:
    None
  • Environment:
    Maven 3.0.4 ; Java 1.6.0_19 ; Linux 2.6.36.2
  • Complexity:
    Intermediate
  • Number of attachments :
    1

Description

Hi,

This is somewhere between a bug and a feature. I am filing it as per krosenv's suggestion.

The Maven surefire plugin is creating two surefire* directories in the $

{project.build.directory}

:

  • surefire (empty after test executions)
  • surefire-reports (containing the output of the tests)

I find this rather annoying. As far as I understand, the surefire directory is used during the testing and it contains some temporary stuff which is removed after the execution of the tests.

I have tried looking up the option to remove the surefire directory, but I can seem to find it. The thing is – I have other projects that don't have this empty directory, just the surefire-reports.

This empty directory breaks tab autocomplete in the console which sort of bugs me, mainly since the directory is empty.

In addition, this is just the test plugin, not the reporting one. There is no section in the project (not any parent).

This is my surefire plugin setup:

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.12</version>
                <configuration>

                    <excludes>
                        <exclude>**/*Abstr*Test*</exclude>
                    </excludes>
                </configuration>
            </plugin>

If this directory is really necessary, I would like to propose the following options:
1) Make surefire use one directory:

- surefire
| |- reports
| |- tmp

This way things will be tidy.

2) Have an option for the plugin which allows you to turn on the preserving of this directory (I think it should be removed by default).

Regards,

Martin

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Martin Todorov added a comment -

I had initially posted a question for this on stackoverflow.com here.

Show
Martin Todorov added a comment - I had initially posted a question for this on stackoverflow.com here .
Hide
Permalink
Grzegorz Slowikowski added a comment -

What will you gain with the changed directories layout? You will have empty "surefire/tmp" directory instead of "surefire". What the empty directory has to do with console autocomplete?

Show
Grzegorz Slowikowski added a comment - What will you gain with the changed directories layout? You will have empty "surefire/tmp" directory instead of "surefire". What the empty directory has to do with console autocomplete?
Hide
Permalink
Martin Todorov added a comment -

Grzegorz, if the surefire directory is empty (whether it's in target or somewhere else), I think it should be removed upon successful tests.

Under Linux, if you want to have the target/surefire-reports path autocompleted for you, when you hit TAB, it will currently stop at target/surefire. Clearly, you can enter the next symbols yourself, but it wasn't like this up until recent versions of the plugin.

The proposed structure will help keep the surefire files tidy (if you really, must have the surefire directory after the tests).

Show
Martin Todorov added a comment - Grzegorz, if the surefire directory is empty (whether it's in target or somewhere else), I think it should be removed upon successful tests. Under Linux, if you want to have the target/surefire-reports path autocompleted for you, when you hit TAB, it will currently stop at target/surefire. Clearly, you can enter the next symbols yourself, but it wasn't like this up until recent versions of the plugin. The proposed structure will help keep the surefire files tidy (if you really, must have the surefire directory after the tests).
Hide
Permalink
Martin Todorov added a comment -

Basically, it doesn't make sense to me to keep the empty directory, if the build has succeeded. And, instead of having a bunch of surefire directories in the target folder, they could simply be placed under the same root.

That's my suggestion.

Show
Martin Todorov added a comment - Basically, it doesn't make sense to me to keep the empty directory, if the build has succeeded. And, instead of having a bunch of surefire directories in the target folder, they could simply be placed under the same root. That's my suggestion.
Hide
Permalink
Tom Vaughan added a comment -

Attaching a proposed patch that cleans up the empty surefire directory after each provider is executed. I used the apache commons io's "FileUtils" class to leverage their deleteDirectory() method which I think is appropriate in this case. If you run the patch from the root of the svn checkout (e.g. you're in the same directory as the master pom.xml file) things should patch up nicely.

Show
Tom Vaughan added a comment - Attaching a proposed patch that cleans up the empty surefire directory after each provider is executed. I used the apache commons io's "FileUtils" class to leverage their deleteDirectory() method which I think is appropriate in this case. If you run the patch from the root of the svn checkout (e.g. you're in the same directory as the master pom.xml file) things should patch up nicely.
Hide
Permalink
Martin Todorov added a comment -

Excellent! The patch looks great!
When can we have it applied? (It's not like this is a blocker issue or anything, but it's quite a bit annoying).

Thanks!

Show
Martin Todorov added a comment - Excellent! The patch looks great! When can we have it applied? (It's not like this is a blocker issue or anything, but it's quite a bit annoying). Thanks!
Hide
Permalink
Tom Vaughan added a comment -
When can we have it applied?

No idea...I'm not a contributor but I agree it is pretty annoying.

Show
Tom Vaughan added a comment - When can we have it applied? No idea...I'm not a contributor but I agree it is pretty annoying.
Hide
Permalink
Tom Vaughan added a comment -

But you should "More Actions->Add Vote" on this ticket to raise its profile.

Show
Tom Vaughan added a comment - But you should "More Actions->Add Vote" on this ticket to raise its profile.
Hide
Permalink
Martin Todorov added a comment -

Well, since I filed it myself, I can't vote.

Show
Martin Todorov added a comment - Well, since I filed it myself, I can't vote.
Hide
Permalink
Kristian Rosenvold added a comment -

Fixed in r1369919. The "surefire" directory is now only left around when maven is run with the -X option for increased logging. Thanks for the patch!

Show
Kristian Rosenvold added a comment - Fixed in r1369919. The "surefire" directory is now only left around when maven is run with the -X option for increased logging. Thanks for the patch!

People

  • Assignee:
    Kristian Rosenvold
    Reporter:
    Martin Todorov
Vote (1)
Watch (2)

Dates

  • Created:
    Updated:
    Resolved: