-
Notifications
You must be signed in to change notification settings - Fork 125
/
TemporaryDirectoryAllocator.java
117 lines (106 loc) · 4.06 KB
/
TemporaryDirectoryAllocator.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/*
* The MIT License
*
* Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.jvnet.hudson.test;
import hudson.FilePath;
import java.io.File;
import java.io.IOException;
import java.util.HashSet;
import java.util.Set;
/**
* Allocates temporary directories and cleans it up at the end.
* @author Kohsuke Kawaguchi
*/
public class TemporaryDirectoryAllocator {
/**
* Remember allocated directories to delete them later.
*/
private final Set<File> tmpDirectories = new HashSet<File>();
/**
* Directory in which we allocate temporary directories.
*/
private final File base;
/**
* Whether there should be a space character in the allocated temporary directories names.
* It forces slaves created from a {@link JenkinsRule} to work inside a hazardous path,
* which can help catching shell quoting bugs.<br>
* This option is controlled by the <code>jenkins.test.noSpaceInTmpDirs</code> system property.
*/
private final boolean withoutSpace = Boolean.getBoolean("jenkins.test.noSpaceInTmpDirs");
@Deprecated
public TemporaryDirectoryAllocator(File base) {
this.base = base;
}
public TemporaryDirectoryAllocator() {
this.base = new File(System.getProperty("java.io.tmpdir"));
base.mkdirs();
}
/**
* Allocates a new empty temporary directory and returns it.
*
* This directory will be wiped out when {@link TemporaryDirectoryAllocator} gets disposed.
* When this method returns, the directory already exists.
*/
public synchronized File allocate() throws IOException {
try {
File f = File.createTempFile((withoutSpace ? "jkh" : "j h"), "", base);
f.delete();
f.mkdirs();
tmpDirectories.add(f);
return f;
} catch (IOException e) {
throw new IOException("Failed to create a temporary directory in "+base,e);
}
}
/**
* Deletes all allocated temporary directories.
*/
public synchronized void dispose() throws IOException, InterruptedException {
IOException x = null;
for (File dir : tmpDirectories)
try {
new FilePath(dir).deleteRecursive();
} catch (IOException e) {
x = e;
}
tmpDirectories.clear();
if (x!=null) throw new IOException("Failed to clean up temp dirs",x);
}
/**
* Deletes all allocated temporary directories asynchronously.
*/
public synchronized void disposeAsync() {
final Set<File> tbr = new HashSet<File>(tmpDirectories);
tmpDirectories.clear();
new Thread("Disposing "+base) {
public void run() {
for (File dir : tbr)
try {
new FilePath(dir).deleteRecursive();
} catch (IOException | InterruptedException e) {
e.printStackTrace();
}
}
}.start();
}
}