Skip to content

Commit

Permalink
[SUREFIRE-2109] Add suffix derived from current user to Surefire temp…
Browse files Browse the repository at this point in the history
… directory name
  • Loading branch information
spannm authored and slawekjaranowski committed Jan 4, 2023
1 parent 0097a41 commit c068b12
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,47 @@
*/

import java.io.File;
import java.util.Objects;
import java.util.stream.Stream;

/**
* Centralized file management of surefire.
* Centralized file management of temporary files in surefire.<br>
* Files are deleted on VM exit.
*
* @author Markus Spann
*/
public final class SureFireFileManager
{

public static File createTempFile( String prefix, String suffix )
private static TempFileManager instance = create();

private static TempFileManager create()
{
String subDirName = "surefire";

return TempFileManager.instance( "surefire" ).createTempFile( prefix, suffix );
// create directory name suffix from legal chars in the current user name
// or a millisecond timestamp as fallback
String userSuffix = Stream.of( "user.name", "USER", "USERNAME" )
.map( System::getProperty )
.filter( Objects::nonNull )
.findFirst()
.map( u -> u.replaceAll( "[^A-Za-z0-9\\-_]", "" ) )
.map( u -> u.isEmpty() ? null : u )
.orElse( Long.toString( System.currentTimeMillis() ) );

if ( userSuffix != null )
{
subDirName += "-" + userSuffix;
}

TempFileManager tfm = TempFileManager.instance( subDirName );
tfm.setDeleteOnExit( true );
return tfm;
}

public static File createTempFile( String prefix, String suffix )
{
return instance.createTempFile( prefix, suffix );
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
package org.apache.maven.surefire.api.util;

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/

import static org.assertj.core.api.Assertions.assertThat;

import junit.framework.TestCase;
import org.junit.Test;

import java.io.File;
import java.io.IOException;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.attribute.PosixFilePermission;
import java.nio.file.attribute.PosixFilePermissions;
import java.util.Set;

/**
* Unit test for the surefire instance of temp file manager.
*
* @author Markus Spann
*/
public class SureFireFileManagerTest extends TestCase
{

@Test
public void testCreateTempFile() throws IOException
{

File tempFile = SureFireFileManager.createTempFile( "sfprefix", "sfsuffix" );
assertThat( tempFile ).isWritable();
assertThat( tempFile.getName() ).startsWith( "sfprefix" ).endsWith( "sfsuffix" );

File tempDir = tempFile.getParentFile();
assertThat( tempDir ).isDirectory().isWritable();
assertThat( tempDir.getName() ).startsWith( "surefire-" ).doesNotMatch( "[^A-Za-z0-9\\\\-_]" );

boolean isPosix = FileSystems.getDefault().supportedFileAttributeViews().contains( "posix" );
if ( isPosix )
{
Set<PosixFilePermission> permissions = Files.getPosixFilePermissions( tempDir.toPath() );
assertEquals( "rwxrwxr-x", PosixFilePermissions.toString( permissions ) );
}

}

}

0 comments on commit c068b12

Please sign in to comment.