forked from actframework/actframework
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathProjectLayout.java
More file actions
647 lines (566 loc) · 20.6 KB
/
ProjectLayout.java
File metadata and controls
647 lines (566 loc) · 20.6 KB
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
package act.app;
/*-
* #%L
* ACT Framework
* %%
* Copyright (C) 2014 - 2017 ActFramework
* %%
* Licensed 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.
* #L%
*/
import static act.app.ProjectLayout.Utils.file;
import static act.app.RuntimeDirs.CLASSES;
import static act.app.RuntimeDirs.CONF;
import static act.route.RouteTableRouterBuilder.ROUTES_FILE;
import act.Act;
import act.app.util.NamedPort;
import org.osgl.$;
import org.osgl.exception.NotAppliedException;
import org.osgl.util.E;
import org.osgl.util.S;
import java.io.File;
import java.io.IOException;
import java.util.*;
/**
* Defines the project file structure supported by Act.
* <p>Used ONLY at dev time for Act to decide where to pick up
* the application srccode files, configuration files etc</p>
*/
public interface ProjectLayout {
/**
* The className of the properties file sit directly in {@code appBase} dir that
* specifies the project layout of the application.
* <p>This properties file is only required if the app project uses a
* customized project layout, i.e. not one of the
* {@link ProjectLayout.PredefinedLayout predefined layouts}:
* </p>
* <ul>
* <li>{@link ProjectLayout.PredefinedLayout#MAVEN maven} or</li>
* <li>{@link ProjectLayout.PredefinedLayout#PLAY play}</li>
* </ul>
*/
String PROJ_LAYOUT_FILE = "proj.layout";
enum PredefinedLayout implements ProjectLayout {
/**
* The standard maven style project layout looks like:
* <pre>
* /<app_root>
* | --- src/
* | --- main/
* | --- java/
* | --- ... # your java packages
* | --- lib/
* | --- ... # your lib folder (contains jar files)
* | --- resources/
* | --- app.conf # the application configuration file
* | --- routes # the routing table
* | --- ... # other resources
* | --- test/
* | --- java/
* | --- ... your test packages
* | --- resources/
* | --- ...
* | --- target/ # the build target folder
* </pre>
* <b>{@code MAVEN} layout is used only when Act running in {@link Act.Mode#DEV dev mode}</b>
*/
MAVEN() {
@Override
public File source(File appBase) {
return file(appBase, "src/main/java");
}
@Override
public File testSource(File appBase) {
return file(appBase, "src/test/java");
}
@Override
public File resource(File appBase) {
String resources = Act.isDev() ? "src/main/resources" : "classes";
return file(appBase, resources);
}
@Override
public File testResource(File appBase) {
String resources = Act.isDev() ? "src/test/resources" : "test-classes";
return file(appBase, resources);
}
@Override
public File lib(File appBase) {
String lib = Act.isDev() ? "src/main/lib" : "lib";
return file(appBase, lib);
}
@Override
public File testLib(File appBase) {
String lib = Act.isDev() ? "src/test/lib" : "test-lib";
return file(appBase, lib);
}
@Override
public String classes() {
return RuntimeDirs.CLASSES;
}
@Override
public File target(File appBase) {
return file(appBase, "target");
}
},
GRADLE_GROOVY() {
@Override
public File source(File appBase) {
return file(appBase, "src/main/groovy");
}
@Override
public File testSource(File appBase) {
return file(appBase, "src/test/groovy");
}
@Override
public File resource(File appBase) {
if (Act.isDev()) {
return file(appBase, "src/main/resources");
}
return file(target(appBase), "resources/main");
}
@Override
public File testResource(File appBase) {
if (Act.isDev()) {
return file(appBase, "src/test/resources");
}
return file(target(appBase), "resources/test");
}
@Override
public File lib(File appBase) {
String lib = Act.isDev() ? "src/main/lib" : "libs";
return file(appBase, lib);
}
@Override
public File testLib(File appBase) {
String lib = Act.isDev() ? "src/test/lib" : "test-libs";
return file(appBase, lib);
}
@Override
public String classes() {
return "classes/groovy/main";
}
@Override
public File target(File appBase) {
return file(appBase, "build");
}
},
GRADLE_GROOVY_IDEA() {
@Override
public File source(File appBase) {
return file(appBase, "src/main/groovy");
}
@Override
public File testSource(File appBase) {
return file(appBase, "src/test/groovy");
}
@Override
public File resource(File appBase) {
if (Act.isDev()) {
return file(appBase, "src/main/resources");
}
return file(appBase, "out/production/resources");
}
@Override
public File testResource(File appBase) {
if (Act.isDev()) {
return file(appBase, "src/test/resources");
}
return file(appBase, "out/test/resources");
}
@Override
public File lib(File appBase) {
String lib = Act.isDev() ? "src/main/lib" : "libs";
return file(appBase, lib);
}
@Override
public File testLib(File appBase) {
String lib = Act.isDev() ? "src/test/lib" : "test-libs";
return file(appBase, lib);
}
@Override
public String classes() {
return "classes";
}
@Override
public File target(File appBase) {
return file(appBase, "out/production");
}
},
PKG() {
@Override
public File source(File appBase) {
return null;
}
@Override
public File testSource(File appBase) {
return null;
}
@Override
public File testResource(File appBase) {
return null;
}
@Override
public File testLib(File appBase) {
return null;
}
@Override
public File resource(File appBase) {
return file(appBase, "classes");
}
@Override
public File lib(File appBase) {
return file(appBase, "lib");
}
@Override
public String classes() {
return RuntimeDirs.CLASSES;
}
@Override
public File target(File appBase) {
return appBase;
}
},
/**
* The Playframework v1.x project layout, looks like:
* <pre>
* /<app_root>
* | --- app/
* | --- # your java packages
* | --- lib/
* | --- # your lib
* | --- conf/
* | --- app.conf # the application configuration file
* | --- routes # the routing table
* | --- ... # other resources
* | --- test/
* | --- # your test packages
* | --- tmp/ # the build target folder
* </pre>
* <b>{@code PLAY} layout is used only when Act running in {@link Act.Mode#DEV dev mode}</b>
*/
PLAY() {
@Override
public File source(File appBase) {
return file(appBase, "app");
}
@Override
public File testSource(File appBase) {
return file(appBase, "test");
}
@Override
public File resource(File appBase) {
return file(appBase, "conf");
}
@Override
public File testResource(File appBase) {
return resource(appBase);
}
@Override
public File lib(File appBase) {
return file(appBase, "lib");
}
@Override
public File testLib(File appBase) {
return lib(appBase);
}
@Override
public String classes() {
return RuntimeDirs.CLASSES;
}
@Override
public File target(File appBase) {
return file(appBase, "tmp");
}
},
;
@Override
public File conf(File appBase) {
File confBase = Act.isDev() ? resource(appBase) : new File(appBase, CLASSES);
File file = new File(confBase, CONF);
return file.exists() ? file : confBase;
}
@Override
public Map<String, List<File>> routeTables(File appBase) {
Map<String, List<File>> map = new HashMap<>();
map.put(NamedPort.DEFAULT, routeTables(appBase, ROUTES_FILE));
for (NamedPort np : Act.app().config().namedPorts()) {
String npName = np.name();
String routesFile = S.concat("routes.", npName, ".conf");
map.put(npName, routeTables(appBase, routesFile));
}
return map;
}
private List<File> routeTables(File appBase, String routesFiile) {
List<File> files = new ArrayList<>();
File resourceBase = resource(appBase);
files.add(file(resourceBase, routesFiile));
File confBase = conf(appBase);
if ($.eq(confBase, resourceBase)) {
// see https://github.com/actframework/actframework/issues/300
return files;
}
files.add(file(confBase, routesFiile));
File commonBase = file(confBase, "common");
files.add(file(commonBase, routesFiile));
File profileBase = file(confBase, Act.profile());
files.add(file(profileBase, routesFiile));
return files;
}
public static ProjectLayout valueOfIgnoreCase(String s) {
s = s.trim().toUpperCase();
if (MAVEN.name().equals(s)) return MAVEN;
if (PLAY.name().equals(s)) return PLAY;
return null;
}
}
/**
* Returns Java srccode file root in relation to the
* {@code appBase}
*/
File source(File appBase);
/**
* Returns test source code file root in test scope in relation
* to the {@code appBase}
* @param appBase
* @return test source code file root
*/
File testSource(File appBase);
/**
* Returns Resource files root in relation to the
* {@code appBase} specified
*
* @param appBase
* @return resource file root
*/
File resource(File appBase);
/**
* Returns test resource files root in test scope in relation to the
* {@code appBase} specified
*
* @param appBase
* @return test resource file root
*/
File testResource(File appBase);
/**
* Returns lib folder which contains arbitrary jar files in relation to the
* {@code appBase} specified
*/
File lib(File appBase);
/**
* Returns lib folder which contains arbitrary jar files in relation to the
* {@code appBase} specified in test scope
*/
File testLib(File appBase);
/**
* Returns classes folder path that is related to the app base
*/
String classes();
/**
* Returns the build target folder in relation to the
* {@code appBase} specified
*/
File target(File appBase);
/**
* Returns the routing table file in relation to the
* {@code appBase} specified. Files are organized by
* named port names
*/
Map<String, List<File>> routeTables(File appBase);
/**
* Returns the app configuration location in relation to the
* {@code appBase} specified.
* <p>The configuration location could be either a File or
* a directory that contains a list of properties files or
* contains sub directories of a list of properties files</p>
*/
File conf(File appBase);
enum util {
;
/**
* check if a dir is application base as per given project layout
*
* @param dir the folder to be probed
* @param layout the project layout used to probe the folder
* @return {@code true if the folder is app base as per given project layout}
*/
public static boolean probeAppBase(File dir, ProjectLayout layout) {
// try conf file
File conf = layout.conf(dir);
if (null != conf && conf.canRead() && conf.isFile()) {
return true;
}
// try source path
File src = layout.source(dir);
if (null != src && src.canRead() && src.isDirectory()) {
// try target path
File tgt = layout.target(dir);
return (null != tgt && tgt.canRead() && tgt.isDirectory());
}
return false;
}
/**
* Build project layout from properties file. The file content shall match the
* project layout interface structure, e.g:
* <pre>
* srccode=src/main/java
* lib=lib
* routes=src/main/resources/routes
* conf=src/main/resources/conf
* target=tmp
* </pre>
*
* @param p
* @return a ProjectLayout instance
*/
public static ProjectLayout build(Properties p) {
String source = _get("source", p);
String testSource = _get("testSource", p);
String lib = _get("lib", p);
String testLib = _get("testLib", p);
String resource = _get("resource", p);
String testResource = _get("testResource", p);
String routes = _get("routes", p);
String conf = _get("conf", p);
String target = _get("target", p);
return new CustomizedProjectLayout(source, testSource, resource, testResource, lib, testLib, target, routes, conf);
}
private static String _get(String key, Properties p) {
String s = p.getProperty(key);
E.invalidConfigurationIf(null == s, "cannot findBy '%s' setting in project layout properties", key);
return s;
}
}
class CustomizedProjectLayout implements ProjectLayout {
private String source;
private String testSource;
private String lib;
private String testLib;
private String routeTable;
private String conf;
private String target;
private String resource;
private String testResource;
public CustomizedProjectLayout(String src, String testSource, String resource, String testResource, String lib, String testLib, String tgt, String routeTable, String conf) {
this.source = src;
this.testSource = testSource;
this.resource = resource;
this.testResource = testResource;
this.lib = lib;
this.testLib = testLib;
this.target = tgt;
this.routeTable = routeTable;
this.conf = conf;
}
@Override
public File source(File appBase) {
return file(appBase, source);
}
@Override
public File testSource(File appBase) {
return file(appBase, testSource);
}
@Override
public File lib(File appBase) {
return file(appBase, lib);
}
@Override
public File testLib(File appBase) {
return file(appBase, testLib);
}
@Override
public Map<String, List<File>> routeTables(File appBase) {
Map<String, List<File>> map = new HashMap<>();
map.put(NamedPort.DEFAULT, routeTables(appBase, routeTable));
// TODO support extended route table (i.e for named ports)
return map;
}
private List<File> routeTables(File appBase, String routeTable) {
List<File> files = new ArrayList<>();
files.add(file(appBase, routeTable));
File confRoot = file(appBase, conf);
files.add(file(confRoot, routeTable));
File profileRoot = file(confRoot, Act.profile());
files.add(file(profileRoot, routeTable));
return files;
}
@Override
public File resource(File appBase) {
return file(appBase, resource);
}
@Override
public File testResource(File appBase) {
return file(appBase, testResource);
}
@Override
public String classes() {
return RuntimeDirs.CLASSES;
}
@Override
public File conf(File appBase) {
return file(appBase, conf);
}
@Override
public File target(File appBase) {
return file(appBase, target);
}
}
enum Utils {
;
public static File file(File parent, String path) {
try {
return new File(parent, path).getCanonicalFile();
} catch (IOException e) {
throw E.ioException(e);
}
}
}
enum F {
;
public static $.F2<File, ProjectLayout, File> SRC = new $.F2<File, ProjectLayout, File>() {
@Override
public File apply(File base, ProjectLayout layout) throws NotAppliedException, $.Break {
return layout.source(base);
}
};
public static $.F2<File, ProjectLayout, File> RSRC = new $.F2<File, ProjectLayout, File>() {
@Override
public File apply(File base, ProjectLayout layout) throws NotAppliedException, $.Break {
return layout.resource(base);
}
};
public static $.F2<File, ProjectLayout, File> LIB = new $.F2<File, ProjectLayout, File>() {
@Override
public File apply(File base, ProjectLayout layout) throws NotAppliedException, $.Break {
return layout.lib(base);
}
};
public static $.F2<File, ProjectLayout, File> TST_SRC = new $.F2<File, ProjectLayout, File>() {
@Override
public File apply(File base, ProjectLayout layout) throws NotAppliedException, $.Break {
return layout.testSource(base);
}
};
public static $.F2<File, ProjectLayout, File> TST_RSRC = new $.F2<File, ProjectLayout, File>() {
@Override
public File apply(File base, ProjectLayout layout) throws NotAppliedException, $.Break {
return layout.testResource(base);
}
};
public static $.F2<File, ProjectLayout, File> TST_LIB = new $.F2<File, ProjectLayout, File>() {
@Override
public File apply(File base, ProjectLayout layout) throws NotAppliedException, $.Break {
return layout.testLib(base);
}
};
}
}