-
Notifications
You must be signed in to change notification settings - Fork 951
/
BuildSettings.groovy
1682 lines (1410 loc) · 58.1 KB
/
BuildSettings.groovy
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
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2008 the original author or authors.
*
* 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.
*/
package grails.util
import org.codehaus.groovy.grails.io.support.IOUtils
import grails.build.logging.GrailsConsole
import org.codehaus.groovy.grails.cli.fork.ForkedGrailsProcess
import static grails.build.logging.GrailsConsole.instance as CONSOLE
import groovy.transform.CompileStatic
import java.util.concurrent.ConcurrentHashMap
import java.util.regex.Pattern
import org.codehaus.groovy.grails.cli.support.ClasspathConfigurer
import org.codehaus.groovy.grails.cli.support.OwnerlessClosure
import org.codehaus.groovy.grails.io.support.IOUtils
import org.codehaus.groovy.grails.resolve.DependencyManager
import org.codehaus.groovy.grails.resolve.DependencyManagerConfigurer
import org.codehaus.groovy.grails.resolve.DependencyReport
import org.codehaus.groovy.grails.resolve.EnhancedDefaultDependencyDescriptor
import org.codehaus.groovy.grails.resolve.GrailsCoreDependencies
import org.codehaus.groovy.grails.resolve.IvyDependencyManager
import org.codehaus.groovy.runtime.StackTraceUtils
/**
* <p>Represents the project paths and other build settings
* that the user can change when running the Grails commands. Defaults
* are provided for all settings, but the user can override those by
* setting the appropriate system property or specifying a value for
* it in the BuildConfig.groovy file.</p>
* <p><b>Warning</b> The behaviour is poorly defined if you explicitly
* set some of the project paths (such as {@link BuildSettings#projectWorkDir}),
* but not others. If you set one of them explicitly, set all of them
* to ensure consistent behaviour.</p>
*/
class BuildSettings extends AbstractBuildSettings {
static final String BUILD_SCOPE = "build"
static final String COMPILE_SCOPE = "compile"
static final String RUNTIME_SCOPE = "runtime"
static final String TEST_SCOPE = "test"
static final String PROVIDED_SCOPE = "provided"
static final String BUILD_SCOPE_DESC = "Dependencies for the build system only"
static final String COMPILE_SCOPE_DESC = "Dependencies placed on the classpath for compilation"
static final String RUNTIME_SCOPE_DESC = "Dependencies needed at runtime but not for compilation"
static final String TEST_SCOPE_DESC = "Dependencies needed for test compilation and execution but not at runtime"
static final String PROVIDED_SCOPE_DESC = "Dependencies needed at development time, but not during deployment"
static final Map<String, String> SCOPE_TO_DESC = [
(BUILD_SCOPE): BUILD_SCOPE_DESC,
(PROVIDED_SCOPE): PROVIDED_SCOPE_DESC,
(COMPILE_SCOPE): COMPILE_SCOPE_DESC,
(RUNTIME_SCOPE): RUNTIME_SCOPE_DESC,
(TEST_SCOPE): TEST_SCOPE_DESC
]
static final Pattern JAR_PATTERN = ~/^\S+\.jar$/
/**
* The compiler source level to use
*/
public static final String COMPILER_SOURCE_LEVEL = "grails.project.source.level"
/**
* The dependency resolver to use
*/
public static final String DEPENDENCY_RESOLVER = "grails.project.dependency.resolver"
/**
* The compiler source level to use
*/
public static final String COMPILER_TARGET_LEVEL = "grails.project.target.level"
/**
* The version of the servlet API
*/
public static final String SERVLET_VERSION = "grails.servlet.version"
/**
* The base directory of the application
*/
public static final String APP_BASE_DIR = "base.dir"
/**
* The name of the system property for {@link #grailsWorkDir}.
*/
public static final String WORK_DIR = "grails.work.dir"
/**
* The name of the system property for {@link #projectWorkDir}.
*/
public static final String PROJECT_WORK_DIR = "grails.project.work.dir"
public static final String OFFLINE_MODE= "grails.offline.mode"
/**
* The name of the system property for {@link #projectWarExplodedDir}.
*/
public static final String PROJECT_WAR_EXPLODED_DIR = "grails.project.war.exploded.dir"
/**
* The name of the system property for {@link #pluginStagingDir}.
*/
public static final String PLUGIN_STAGING_DIR = "grails.project.plugin.staging.dir"
/**
* The name of the system property for {@link #pluginIncludeSource}.
*/
public static final String PLUGIN_INCLUDE_SOURCE = "grails.project.plugin.includeSource"
/**
* The name of the system property for {@link #projectPluginsDir}.
*/
public static final String PLUGINS_DIR = "grails.project.plugins.dir"
/**
* The name of the system property for {@link #globalPluginsDir}.
*/
public static final String GLOBAL_PLUGINS_DIR = "grails.global.plugins.dir"
/**
* The name of the system property for {@link #}.
*/
public static final String PROJECT_RESOURCES_DIR = "grails.project.resource.dir"
/**
* The name of the system property for {@link #sourceDir}.
*/
public static final String PROJECT_SOURCE_DIR = "grails.project.source.dir"
/**
* The name of the system property for {@link BuildSettings#webXmlLocation}.
*/
public static final String PROJECT_WEB_XML_FILE = "grails.project.web.xml"
/**
* The name of the system property for {@link #classesDir}.
*/
public static final String PROJECT_CLASSES_DIR = "grails.project.class.dir"
/**
* The name of the system property for {@link #pluginClassesDir}.
*/
public static final String PROJECT_PLUGIN_CLASSES_DIR = "grails.project.plugin.class.dir"
/**
* The name of the system property for {@link #pluginBuildClassesDir}.
*/
public static final String PROJECT_PLUGIN_BUILD_CLASSES_DIR = "grails.project.plugin.build.class.dir"
/**
* The name of the system property for {@link #pluginProvidedClassesDir}.
*/
public static final String PROJECT_PLUGIN_PROVIDED_CLASSES_DIR = "grails.project.plugin.provided.class.dir"
/**
* The name of the system property for {@link #testClassesDir}.
*/
public static final String PROJECT_TEST_CLASSES_DIR = "grails.project.test.class.dir"
/**
* The name of the system property for {@link #testReportsDir}.
*/
public static final String PROJECT_TEST_REPORTS_DIR = "grails.project.test.reports.dir"
/**
* The name of the system property for {@link #docsOutputDir}.
*/
public static final String PROJECT_DOCS_OUTPUT_DIR = "grails.project.docs.output.dir"
/**
* The name of the system property for {@link #testSourceDir}.
*/
public static final String PROJECT_TEST_SOURCE_DIR = "grails.project.test.source.dir"
/**
* The name of the system property for {@link #projectTargetDir}.
*/
public static final String PROJECT_TARGET_DIR = "grails.project.target.dir"
/**
* The name of the WAR file of the project
*/
public static final String PROJECT_WAR_FILE = "grails.project.war.file"
/**
* The name of the WAR file of the project
*/
public static final String PROJECT_AUTODEPLOY_DIR = "grails.project.autodeploy.dir"
/**
* The name of the system property for enabling osgi headers in the WAR Manifest
*/
public static final String PROJECT_WAR_OSGI_HEADERS = "grails.project.war.osgi.headers"
/**
* The name of the system property for multiple {@link #buildListeners}.
*/
public static final String BUILD_LISTENERS = "grails.build.listeners"
/**
* The name of the system property for enabling verbose compilation {@link #verboseCompile}.
*/
public static final String VERBOSE_COMPILE = "grails.project.compile.verbose"
/**
* A system property with this name is populated in the preparation phase of functional testing
* with the base URL that tests should be run against.
*/
public static final String FUNCTIONAL_BASE_URL_PROPERTY = 'grails.testing.functional.baseUrl'
/**
* The name of the working directory for commands that don't belong to a project (like create-app)
*/
public static final String CORE_WORKING_DIR_NAME = '.core'
/**
* A property name to enable/disable AST conversion of closures actions&tags to methods
*/
public static final String CONVERT_CLOSURES_KEY = "grails.compile.artefacts.closures.convert"
/**
* Property name to enable/disable script event time logging.
*/
public static final String LOG_SCRIPT_TIMING_KEY = 'grails.script.logTiming'
/**
* The base directory for the build, which is normally the root
* directory of the current project. If a command is run outside
* of a project, then this will be the current working directory
* that the command was launched from.
*/
File baseDir
/** Location of the current user's home directory - equivalent to "user.home" system property. */
File userHome
/**
* Location of the Grails distribution as usually identified by
* the GRAILS_HOME environment variable. This value may be
* <code>null</code> if GRAILS_HOME is not set, for example if a
* project uses the Grails JAR files directly.
*/
File grailsHome
/** The version of Grails being used for the current script. */
String grailsVersion
/** The environment for the current script. */
String grailsEnv
/**
* The compiler source level to use
*/
String compilerSourceLevel
/**
* The compiler target level to use
*/
String compilerTargetLevel = "1.6"
/**
* The dependency resolution engine to use (aether or ivy)
*/
String dependencyResolver = "ivy"
/** <code>true</code> if the default environment for a script should be used. */
boolean defaultEnv
/**
* whether to include source attachments in a resolve
*/
boolean includeSource
/**
* whether to include javadoc attachments in a resolve
*/
boolean includeJavadoc
/**
* Whether the project required build dependencies are externally configured (by Maven for example) or not
*/
boolean dependenciesExternallyConfigured = false
/**
* Whether to enable resolving dependencies
*/
boolean enableResolve = true
/** The location of the Grails working directory where non-project-specific temporary files are stored. */
File grailsWorkDir
/** The location of the project working directory for project-specific temporary files. */
File projectWorkDir
/** The location of the project target directory where reports, artifacts and so on are output. */
File projectTargetDir
/** The location of the Grails WAR directory where exploded WAR is built. */
File projectWarExplodedDir
/** The location of the temporary directory where plugins are staged before being bundled into a ZIP or JAR file. */
File pluginStagingDir
/** Whether to include the source in binary plugin JAR files. */
Boolean pluginIncludeSource
/**
* The WAR file of the project
*/
File projectWarFile
/**
* Directory where additional war files to be autodeployed are located
*/
File autodeployDir
/**
* Setting for whether or not to enable OSGI headers in the WAR Manifest, can be overridden via -verboseCompile(=[true|false])?
*/
boolean projectWarOsgiHeaders = false
/** The location to which Grails compiles a project's classes. */
File classesDir
/** The location to which Grails compiles a project's test classes and any test scoped plugin classes. */
File testClassesDir
/** The location to which Grails compiles a project's plugin classes. Plugin classes that are compile or runtime scoped will be compiled to this directory */
File pluginClassesDir
/**
* The location to which Grails compiles build scoped plugins classes.
*/
File pluginBuildClassesDir
/**
* The location to which Grails compiles provided scoped plugins classes.
*/
File pluginProvidedClassesDir
/** The location where Grails keeps temporary copies of a project's resources. */
File resourcesDir
/** The location of the plain source. */
File sourceDir
/** The location of the test reports. */
File testReportsDir
/** The location of the documentation output. */
File docsOutputDir
/** The location of the test source. */
File testSourceDir
/**
* The version of the servlet API used
*/
String servletVersion = "2.5"
/** The root loader for the build. This has the required libraries on the classpath. */
URLClassLoader rootLoader
/**
* The settings used to establish the HTTP proxy to use for dependency resolution etc.
*/
ConfigObject proxySettings = new ConfigObject()
/**
* The file containing the proxy settings
*/
File proxySettingsFile
/**
* Fork Settings. These are the default settings used to control forked mode, and what
*/
Map<String, Object> forkSettings = [run:false, test:false, console:false, shell:false, compile:false]
/** Implementation of the "grailsScript()" method used in Grails scripts. */
private boolean useMavenDependencyResolver
Closure getGrailsScriptClosure() {
return new OwnerlessClosure() {
Object doCall(String name) {
if(grailsHome != null) {
def potentialScript = new File(grailsHome, "scripts/${name}.groovy")
potentialScript = potentialScript.exists() ? potentialScript : new File(grailsHome, "scripts/${name}_.groovy")
if (potentialScript.exists()) {
return potentialScript
}
}
try {
return classLoader.loadClass("${name}_")
}
catch (e) {
return classLoader.loadClass(name)
}
}
}
}
/**
* A Set of plugin names that represent the default set of plugins installed when creating Grails applications
*/
Set defaultPluginSet
/**
* A Set of plugin names and versions that represent the default set of plugins installed when creating Grails applications
*/
Map defaultPluginMap
/**
* Location of the generated web.xml file
*/
File webXmlLocation
/**
* List of jars provided in the applications 'lib' directory
*/
List<File> applicationJars = []
List buildListeners = []
List<File> pluginDependencies = []
boolean convertClosuresArtefacts = false
/**
* Setting for whether or not to enable verbose compilation, can be overridden via -verboseCompile(=[true|false])?
*/
boolean verboseCompile = false
/**
* Return whether the BuildConfig has been modified
*/
boolean modified = false
/**
* Whether the build is allowed to connect to remote servers to resolve dependencies
*/
boolean offline = false
boolean logScriptTiming = false
GrailsCoreDependencies coreDependencies
private List<File> compileDependencies = []
private boolean defaultCompileDepsAdded = false
private List<File> internalPluginCompileDependencies = []
private List<File> internalPluginTestDependencies = []
private List<File> internalPluginBuildDependencies = []
private List<File> internalPluginRuntimeDependencies = []
private List<File> internalPluginProvidedDependencies = []
/** List containing the compile-time dependencies of the app as File instances. */
@CompileStatic
List<File> getCompileDependencies() {
if (!defaultCompileDepsAdded) {
compileDependencies += defaultCompileDependencies
defaultCompileDepsAdded = true
}
return compileDependencies
}
/**
* Sets the compile time dependencies for the project
*/
@CompileStatic
void setCompileDependencies(List<File> deps) {
def jarFiles = findAndRemovePluginDependencies("compile", deps, internalPluginCompileDependencies)
compileDependencies = jarFiles
}
DependencyReport buildResolveReport
DependencyReport compileResolveReport
DependencyReport testResolveReport
DependencyReport runtimeResolveReport
DependencyReport providedResolveReport
/** List containing the default (resolved via the dependencyManager) compile-time dependencies of the app as File instances. */
private List<File> internalCompileDependencies
@Lazy List<File> defaultCompileDependencies = {
if (dependenciesExternallyConfigured) {
return []
}
if (internalCompileDependencies) return internalCompileDependencies
List<File> jarFiles
if (shouldResolve()) {
jarFiles = doResolve("compile", internalPluginCompileDependencies)
}
else {
jarFiles = []
}
return jarFiles
}()
@CompileStatic
List<File> doResolve(String scope, List<File> pluginZips, boolean includeAppJars = true) {
final resolveReport = dependencyManager.resolve(scope)
if (resolveReport.hasError()) {
final console = GrailsConsole.getInstance()
final error = resolveReport.getResolveError()
console.error("Resolve error obtaining dependencies: ${error.message}", error)
}
((GroovyObject)this).setProperty("${scope}ResolveReport".toString(), resolveReport )
List<File> jarFiles
if (includeAppJars) {
jarFiles = []
jarFiles.addAll(resolveReport.jarFiles)
jarFiles.addAll(applicationJars)
} else {
jarFiles = resolveReport.jarFiles
}
pluginZips.addAll(resolveReport.pluginZips)
this.pluginDependencies.addAll(resolveReport.pluginZips)
pluginDependencies.unique(true)
resolveCache[scope] = resolveReport.allArtifacts
jarFiles
}
@CompileStatic
boolean isGrailsProject() {
return new File(getBaseDir(), "grails-app").exists()
}
@CompileStatic
private List<File> findAndRemovePluginDependencies(String scope, Collection<File> jarFiles, List<File> scopePluginDependencies) {
jarFiles = jarFiles?.findAll { File it -> it != null} ?: new ArrayList<File>()
def pluginZips = jarFiles.findAll { File it -> it.name.endsWith(".zip") }
for (z in pluginZips) {
if (!pluginDependencies.contains(z)) {
pluginDependencies.add(z)
}
}
scopePluginDependencies.addAll(pluginZips)
resolveCache[scope] = jarFiles
jarFiles = jarFiles.findAll { File it -> !it.name.endsWith(".zip") }
return jarFiles as List
}
private List<File> testDependencies = []
private boolean defaultTestDepsAdded = false
/** List containing the test-time dependencies of the app as File instances. */
@CompileStatic
List<File> getTestDependencies() {
if (!defaultTestDepsAdded) {
testDependencies += defaultTestDependencies
defaultTestDepsAdded = true
}
return testDependencies
}
/**
* Sets the test time dependencies for the project
*/
@CompileStatic
void setTestDependencies(List<File> deps) {
def jarFiles = findAndRemovePluginDependencies("test", deps, internalPluginTestDependencies)
testDependencies = jarFiles
}
/** List containing the default test-time dependencies of the app as File instances. */
private List<File> internalTestDependencies
@Lazy List<File> defaultTestDependencies = {
if (dependenciesExternallyConfigured) {
return []
}
if (internalTestDependencies) return internalTestDependencies
if (shouldResolve()) {
return doResolve("test", internalPluginTestDependencies)
}
else {
return []
}
}()
private List<File> runtimeDependencies = []
private boolean defaultRuntimeDepsAdded = false
/** List containing the runtime dependencies of the app as File instances. */
@CompileStatic
List<File> getRuntimeDependencies() {
if (!defaultRuntimeDepsAdded) {
runtimeDependencies += defaultRuntimeDependencies
defaultRuntimeDepsAdded = true
}
return runtimeDependencies
}
/**
* Sets the runtime dependencies for the project
*/
@CompileStatic
void setRuntimeDependencies(List<File> deps) {
def jarFiles = findAndRemovePluginDependencies("runtime", deps, internalPluginRuntimeDependencies)
runtimeDependencies = jarFiles
}
/** List containing the default runtime-time dependencies of the app as File instances. */
private List<File> internalRuntimeDependencies
@Lazy List<File> defaultRuntimeDependencies = {
if (dependenciesExternallyConfigured) {
return []
}
if (internalRuntimeDependencies) return internalRuntimeDependencies
if (shouldResolve()) {
return doResolve("runtime", internalPluginRuntimeDependencies)
}
return []
}()
private List<File> providedDependencies = []
private boolean defaultProvidedDepsAdded = false
/** List containing the runtime dependencies of the app as File instances. */
@CompileStatic
List<File> getProvidedDependencies() {
if (!defaultProvidedDepsAdded) {
providedDependencies += defaultProvidedDependencies
defaultProvidedDepsAdded = true
}
return providedDependencies
}
/**
* Sets the runtime dependencies for the project
*/
@CompileStatic
void setProvidedDependencies(List<File> deps) {
def jarFiles = findAndRemovePluginDependencies("provided", deps, internalPluginProvidedDependencies)
providedDependencies = jarFiles
}
/** List containing the dependencies needed at development time, but provided by the container at runtime **/
private List<File> internalProvidedDependencies
@Lazy List<File> defaultProvidedDependencies = {
if (dependenciesExternallyConfigured) {
return []
}
if (internalProvidedDependencies) return internalProvidedDependencies
if (shouldResolve()) {
return doResolve("provided", internalPluginProvidedDependencies, false)
}
return []
}()
private List<File> buildDependencies = []
private boolean defaultBuildDepsAdded = false
/** List containing the runtime dependencies of the app as File instances. */
@CompileStatic
List<File> getBuildDependencies() {
if (!defaultBuildDepsAdded) {
buildDependencies += defaultBuildDependencies
defaultBuildDepsAdded = true
}
return buildDependencies
}
/**
* Obtains a list of source plugins that are provided time dependencies
*
* @return A list of the source zips
*/
@CompileStatic
List<File> getPluginCompileDependencies() {
// ensure initialization
if (!internalPluginCompileDependencies) {
getCompileDependencies()
}
return internalPluginCompileDependencies
}
/**
* Obtains a list of source plugins that are provided time dependencies
*
* @return A list of the source zips
*/
@CompileStatic
List<File> getPluginProvidedDependencies() {
// ensure initialization
if (!internalPluginProvidedDependencies) {
getProvidedDependencies()
}
return internalPluginProvidedDependencies
}
/**
* Obtains a list of source plugins that are runtime time dependencies
*
* @return A list of the source zips
*/
@CompileStatic
List<File> getPluginRuntimeDependencies() {
// ensure initialization
if (!internalPluginRuntimeDependencies) {
getRuntimeDependencies()
}
return internalPluginRuntimeDependencies
}
/**
* Obtains a list of source plugins that are test time dependencies
*
* @return A list of the source zips
*/
@CompileStatic
List<File> getPluginTestDependencies() {
// ensure initialization
if (!internalPluginTestDependencies) {
getTestDependencies()
}
return internalPluginTestDependencies
}
/**
* Obtains a list of source plugins that are build time dependencies
*
* @return A list of the source zips
*/
@CompileStatic
List<File> getPluginBuildDependencies() {
// ensure initialization
if (!internalPluginBuildDependencies) {
getBuildDependencies()
}
return internalPluginBuildDependencies
}
/**
* Sets the runtime dependencies for the project
*/
@CompileStatic
void setBuildDependencies(List<File> deps) {
def jarFiles = findAndRemovePluginDependencies("build", deps, internalPluginBuildDependencies)
buildDependencies = jarFiles
}
/**
* List containing the dependencies required for the build system only
*/
private List<File> internalBuildDependencies
@Lazy List<File> defaultBuildDependencies = {
if (dependenciesExternallyConfigured) {
return []
}
if (internalBuildDependencies) return internalBuildDependencies
if (shouldResolve()) {
return doResolve("build", internalPluginBuildDependencies)
}
return []
}()
protected boolean shouldResolve() {
return dependencyManager != null && enableResolve
}
/**
* Manages dependencies and dependency resolution in a Grails application
*/
DependencyManager dependencyManager
/*
* This is an unclever solution for handling "sticky" values in the
* project paths, but trying to be clever so far has failed. So, if
* the values of properties such as "grailsWorkDir" are set explicitly
* (from outside the class), then they are not overridden by system
* properties/build config.
*
* TODO Sort out this mess. Must decide on what can set this properties,
* when, and how. Also when and how values can be overridden. This
* is critically important for the Maven and Ant support.
*/
private boolean grailsWorkDirSet
private boolean projectWorkDirSet
private boolean projectTargetDirSet
private boolean projectWarExplodedDirSet
private boolean pluginStagingDirSet
private boolean pluginIncludeSourceSet
private boolean classesDirSet
private boolean testClassesDirSet
private boolean pluginClassesDirSet
private boolean pluginBuildClassesDirSet
private boolean pluginProvidedClassesDirSet
private boolean resourcesDirSet
private boolean sourceDirSet
private boolean webXmlFileSet
private boolean testReportsDirSet
private boolean docsOutputDirSet
private boolean testSourceDirSet
private boolean projectWarFileSet
private boolean autodeployDirSet
private boolean projectWarOsgiHeadersSet
private boolean buildListenersSet
private boolean verboseCompileSet
private boolean convertClosuresArtefactsSet
private boolean logScriptTimingSet
private String resolveChecksum
private Map resolveCache = new ConcurrentHashMap()
private boolean readFromCache = false
BuildSettings() {
this(null)
}
BuildSettings(File grailsHome) {
this(grailsHome, null)
}
BuildSettings(File grailsHome, File baseDir) {
userHome = new File(System.getProperty("user.home"))
if (grailsHome) this.grailsHome = grailsHome
// Load the 'build.properties' file from the classpath and
// retrieve the Grails version from it.
Properties buildProps = new Properties()
try {
loadBuildPropertiesFromClasspath(buildProps)
grailsVersion = buildProps.'grails.version'
}
catch (IOException ex) {
throw new IOException("Unable to find 'build.properties' - make " +
"that sure the 'grails-core-*.jar' file is on the classpath.")
}
// If 'grailsHome' is set, add the JAR file dependencies.
defaultPluginMap = [:]
defaultPluginSet = defaultPluginMap.keySet()
// Update the base directory. This triggers some extra config.
setBaseDir(baseDir)
if (![Environment.DEVELOPMENT, Environment.TEST].contains(Environment.current)) {
modified = true
}
// The "grailsScript" closure definition. Returns the location
// of the corresponding script file if GRAILS_HOME is set,
// otherwise it loads the script class using the Gant classloader.
}
boolean isDependenciesExternallyConfigured() {
return dependenciesExternallyConfigured
}
void setDependenciesExternallyConfigured(boolean dependenciesExternallyConfigured) {
if(dependenciesExternallyConfigured) {
setForkSettings([run:false, test:false, console:false, shell:false, compile:false])
}
this.dependenciesExternallyConfigured = dependenciesExternallyConfigured
}
@CompileStatic
void storeDependencyCache() {
projectWorkDir.mkdirs()
if (resolveChecksum) {
try {
if (resolveCache.size() == 5 && !readFromCache) {
def cachedResolve = new File(projectWorkDir, "${resolveChecksum}.resolve")
cachedResolve.withOutputStream { OutputStream output ->
new ObjectOutputStream(output).writeObject(resolveCache)
}
}
}
catch (e) {
ClasspathConfigurer.cleanResolveCache(this)
}
}
}
@CompileStatic
protected void loadBuildPropertiesFromClasspath(Properties buildProps) {
InputStream stream = getClass().classLoader.getResourceAsStream("grails.build.properties")
if (stream == null) {
stream = getClass().classLoader.getResourceAsStream("build.properties")
}
if (stream) {
buildProps.load(stream)
}
}
/**
* <p>Changes the base directory, making sure that everything that
* depends on it gets refreshed too. If you have have previously
* loaded a configuration file, you should load it again after
* calling this method.</p>
* <p><b>Warning</b> This method resets the project paths, so if
* they have been set manually by the caller, then that information
* will be lost!</p>
*/
@CompileStatic
void setBaseDir(File newBaseDir) {
baseDir = newBaseDir ?: establishBaseDir()
// Initialize Metadata
Metadata.getInstance(new File(baseDir, "application.properties"))
// Set up the project paths, using an empty config for now. The
// paths will be updated if and when a BuildConfig configuration
// file is loaded.
config = new ConfigObject()
establishProjectStructure()
if (baseDir) {
// Add the application's libraries.
def appLibDir = new File(baseDir, "lib")
if (appLibDir.exists()) {
appLibDir.eachFileMatch(JAR_PATTERN) { File it ->
applicationJars << it
}
}
}
}
void setGrailsWorkDir(File dir) {
grailsWorkDir = dir
grailsWorkDirSet = true
}
void setProjectWorkDir(File dir) {
projectWorkDir = dir
projectWorkDirSet = true
}
void setProjectTargetDir(File dir) {
projectTargetDir = dir
projectTargetDirSet = true
}
void setProjectWarFile(File file) {
projectWarFile = file
projectWarFileSet = true
}
void setProjectWarExplodedDir(File dir) {
projectWarExplodedDir = dir
projectWarExplodedDirSet = true
}
void setPluginStagingDir(File dir) {
pluginStagingDir = dir
pluginStagingDirSet = true
}
void setPluginIncludeSource(boolean include) {
pluginIncludeSource = include
pluginIncludeSourceSet = true
}
void setConvertClosuresArtefacts(boolean convert) {
convertClosuresArtefacts = convert
convertClosuresArtefactsSet = true
}
void setLogScriptTiming(boolean b) {
logScriptTiming = b
logScriptTimingSet = true
}
void setProjectWarOsgiHeaders(boolean flag) {
projectWarOsgiHeaders = flag
projectWarOsgiHeadersSet = true
}
void setClassesDir(File dir) {
classesDir = dir
classesDirSet = true
}
void setTestClassesDir(File dir) {
testClassesDir = dir
testClassesDirSet = true
}
void setPluginClassesDir(File dir) {