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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
# THIS FILE IS PART OF THE CYLC WORKFLOW ENGINE.
# Copyright (C) NIWA & British Crown (Met Office) & Contributors.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""Utilities for testing workflow directory structure.
(There should be no tests in this module.)
A filetree is represented by a dict like so:
{
# Dirs are represented by dicts (which are also sub-filetrees):
'dir': {
'another-dir': {
# Files are represented by None:
'file.txt': None
}
},
# Symlinks are represented by the Symlink class, with the target
# represented by the relative path from the tmp_path directory:
'symlink': Symlink('dir/another-dir')
}
"""
from pathlib import Path, PosixPath
from typing import Any, Dict, List
class Symlink(PosixPath):
"""A class to represent a symlink target."""
...
def create_filetree(
filetree: Dict[str, Any], location: Path, root: Path
) -> None:
"""Create the directory structure represented by the filetree dict.
Args:
filetree: The filetree to create.
location: The absolute path in which to create the filetree.
root: The top-level dir from which relative symlink targets are
located (typically tmp_path).
"""
for name, entry in filetree.items():
path = location / name
if isinstance(entry, dict):
path.mkdir(exist_ok=True)
create_filetree(entry, path, root)
elif isinstance(entry, Symlink):
path.symlink_to(root / entry)
else:
path.touch()
def get_filetree_as_list(
filetree: Dict[str, Any], location: Path
) -> List[str]:
"""Return a list of the paths in a filetree.
Args:
filetree: The filetree to listify.
location: The absolute path to the filetree.
"""
ret: List[str] = []
for name, entry in filetree.items():
path = location / name
ret.append(str(path))
if isinstance(entry, dict):
ret.extend(get_filetree_as_list(entry, path))
return ret
FILETREE_1 = {
'cylc-run': {
'foo': {
'bar': {
'.service': {
'db': None,
},
'flow.cylc': None,
'log': Symlink('sym/cylc-run/foo/bar/log'),
'mirkwood': Symlink('you-shall-not-pass/mirkwood'),
'rincewind.txt': Symlink('you-shall-not-pass/rincewind.txt'),
},
},
},
'sym': {
'cylc-run': {
'foo': {
'bar': {
'log': {
'darmok': Symlink('you-shall-not-pass/darmok'),
'temba.txt': Symlink('you-shall-not-pass/temba.txt'),
'bib': {
'fortuna.txt': None,
},
},
},
},
},
},
'you-shall-not-pass': { # Nothing in here should get deleted
'darmok': {
'jalad.txt': None,
},
'mirkwood': {
'spiders.txt': None,
},
'rincewind.txt': None,
'temba.txt': None,
},
}
FILETREE_2 = {
'cylc-run': {'foo': {'bar': Symlink('sym-run/cylc-run/foo/bar')}},
'sym-run': {
'cylc-run': {
'foo': {
'bar': {
'.service': {
'db': None,
},
'flow.cylc': None,
'share': Symlink('sym-share/cylc-run/foo/bar/share'),
},
},
},
},
'sym-share': {
'cylc-run': {
'foo': {
'bar': {
'share': {
'cycle': Symlink(
'sym-cycle/cylc-run/foo/bar/share/cycle'
),
},
},
},
},
},
'sym-cycle': {
'cylc-run': {
'foo': {
'bar': {
'share': {
'cycle': {
'macklunkey.txt': None,
},
},
},
},
},
},
'you-shall-not-pass': {},
}
FILETREE_3 = {
'cylc-run': {
'foo': {
'bar': Symlink('sym-run/cylc-run/foo/bar'),
},
},
'sym-run': {
'cylc-run': {
'foo': {
'bar': {
'.service': {
'db': None,
},
'flow.cylc': None,
'share': {
'cycle': Symlink(
'sym-cycle/cylc-run/foo/bar/share/cycle'
),
},
},
},
},
},
'sym-cycle': {
'cylc-run': {
'foo': {
'bar': {
'share': {
'cycle': {
'sokath.txt': None,
},
},
},
},
},
},
'you-shall-not-pass': {},
}
FILETREE_4 = {
'cylc-run': {
'foo': {
'bar': {
'.service': {
'db': None,
},
'flow.cylc': None,
'share': {
'cycle': Symlink('sym-cycle/cylc-run/foo/bar/share/cycle'),
},
},
},
},
'sym-cycle': {
'cylc-run': {
'foo': {
'bar': {
'share': {
'cycle': {
'kiazi.txt': None,
},
},
},
},
},
},
'you-shall-not-pass': {},
}
|
