{{ message }}
Repository navigation
Expand file tree
/
Copy pathJavaPlatform.cs
More file actions
432 lines (375 loc) · 17 KB
/
Copy pathJavaPlatform.cs
File metadata and controls
432 lines (375 loc) · 17 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
// --------------------------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
// --------------------------------------------------------------------------------------------
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.ApplicationInsights;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Microsoft.Oryx.BuildScriptGenerator.Exceptions;
using Microsoft.Oryx.Detector;
using Microsoft.Oryx.Detector.Java;
namespace Microsoft.Oryx.BuildScriptGenerator.Java
{
/// <summary>
/// Java Platform.
/// </summary>
internal class JavaPlatform : IProgrammingPlatform
{
/// <summary>
/// The tar-gz option for Java modules.
/// </summary>
private readonly BuildScriptGeneratorOptions commonOptions;
private readonly ScriptGeneratorOptionsForJava javaScriptGeneratorOptions;
private readonly IJavaVersionProvider javaVersionProvider;
private readonly IMavenVersionProvider mavenVersionProvider;
private readonly ILogger<JavaPlatform> logger;
private readonly IJavaPlatformDetector detector;
private readonly JavaPlatformInstaller javaPlatformInstaller;
private readonly MavenInstaller mavenInstaller;
private readonly TelemetryClient telemetryClient;
/// <summary>
/// Initializes a new instance of the <see cref="JavaPlatform"/> class.
/// </summary>
/// <param name="commonOptions">The <see cref="BuildScriptGeneratorOptions"/>.</param>
/// <param name="javaScriptGeneratorOptions">The options for JavaScriptGenerator.</param>
/// <param name="javaVersionProvider">The <see cref="JavaVersionProvider"/>.</param>
/// <param name="mavenVersionProvider">The <see cref="IMavenVersionProvider"/>.</param>
/// <param name="logger">The logger of Java platform.</param>
/// <param name="detector">The detector of Java platform.</param>
/// <param name="javaPlatformInstaller">The <see cref="JavaPlatformInstaller"/>.</param>
/// <param name="mavenInstaller">The <see cref="MavenInstaller"/>.</param>
public JavaPlatform(
IOptions<BuildScriptGeneratorOptions> commonOptions,
IOptions<ScriptGeneratorOptionsForJava> javaScriptGeneratorOptions,
IJavaVersionProvider javaVersionProvider,
IMavenVersionProvider mavenVersionProvider,
ILogger<JavaPlatform> logger,
IJavaPlatformDetector detector,
JavaPlatformInstaller javaPlatformInstaller,
MavenInstaller mavenInstaller,
TelemetryClient telemetryClient)
{
this.commonOptions = commonOptions.Value;
this.javaScriptGeneratorOptions = javaScriptGeneratorOptions.Value;
this.javaVersionProvider = javaVersionProvider;
this.mavenVersionProvider = mavenVersionProvider;
this.logger = logger;
this.detector = detector;
this.javaPlatformInstaller = javaPlatformInstaller;
this.mavenInstaller = mavenInstaller;
this.telemetryClient = telemetryClient;
}
/// <inheritdoc/>
public string Name => JavaConstants.PlatformName;
/// <inheritdoc/>
public IEnumerable<string> SupportedVersions
{
get
{
var versionInfo = this.javaVersionProvider.GetVersionInfo();
return versionInfo.SupportedVersions;
}
}
/// <inheritdoc/>
public PlatformDetectorResult Detect(RepositoryContext context)
{
var detectionResult = this.detector.Detect(new DetectorContext
{
SourceRepo = new Detector.LocalSourceRepo(context.SourceRepo.RootPath),
});
if (detectionResult == null)
{
return null;
}
this.ResolveVersions(context, detectionResult);
return detectionResult;
}
/// <inheritdoc/>
public BuildScriptSnippet GenerateBashBuildScriptSnippet(
BuildScriptGeneratorContext ctx,
PlatformDetectorResult detectorResult)
{
var javaPlatformDetectorResult = detectorResult as JavaPlatformDetectorResult;
if (javaPlatformDetectorResult == null)
{
throw new ArgumentException(
$"Expected '{nameof(detectorResult)}' argument to be of type " +
$"'{typeof(JavaPlatformDetectorResult)}' but got '{detectorResult.GetType()}'.");
}
var manifestFileProperties = new Dictionary<string, string>();
// Write the platform name and version to the manifest file
manifestFileProperties[ManifestFilePropertyKeys.JavaVersion] = detectorResult.PlatformVersion;
string command = string.Empty;
if (javaPlatformDetectorResult.UsesMavenWrapperTool)
{
if (this.commonOptions.ShouldPackage)
{
command = JavaConstants.CreatePackageCommandUsingMavenWrapper;
}
else
{
command = JavaConstants.CompileCommandUsingMavenWrapper;
}
}
else if (javaPlatformDetectorResult.UsesMaven)
{
if (this.commonOptions.ShouldPackage)
{
command = JavaConstants.CreatePackageCommandUsingMaven;
}
else
{
command = JavaConstants.CompileCommandUsingMaven;
}
// Maven spits out lot of information related to downloading of packages which is too verbose.
// Since the --quiet option is too quiet, we are trying to use a new switch below to just mute the
// messages related to transfer progress of these downloads.
// https://maven.apache.org/docs/3.6.1/release-notes.html#user-visible-changes
var currentMavenVersion = new SemanticVersioning.Version(javaPlatformDetectorResult.MavenVersion);
if (currentMavenVersion.CompareTo(JavaConstants.MinMavenVersionWithNoTransferProgressSupport) >= 0)
{
command = $"{command} --no-transfer-progress";
}
}
var scriptProps = new JavaBashBuildSnippetProperties();
scriptProps.UsesMaven = javaPlatformDetectorResult.UsesMaven;
scriptProps.UsesMavenWrapperTool = javaPlatformDetectorResult.UsesMavenWrapperTool;
scriptProps.Command = command;
string script = TemplateHelper.Render(
TemplateHelper.TemplateResource.JavaBuildSnippet,
scriptProps,
this.logger,
this.telemetryClient);
return new BuildScriptSnippet
{
BashBuildScriptSnippet = script,
BuildProperties = manifestFileProperties,
};
}
/// <inheritdoc/>
public bool IsCleanRepo(ISourceRepo repo)
{
return true;
}
/// <inheritdoc/>
public bool IsEnabled(RepositoryContext ctx)
{
return this.commonOptions.EnableJavaBuild;
}
/// <inheritdoc/>
public bool IsEnabledForMultiPlatformBuild(RepositoryContext ctx)
{
return true;
}
/// <inheritdoc/>
public string GenerateBashRunTimeInstallationScript(RunTimeInstallationScriptGeneratorOptions options)
{
throw new NotImplementedException();
}
/// <inheritdoc/>
public IEnumerable<string> GetDirectoriesToExcludeFromCopyToBuildOutputDir(BuildScriptGeneratorContext ctx)
{
return Array.Empty<string>();
}
/// <inheritdoc/>
public IEnumerable<string> GetDirectoriesToExcludeFromCopyToIntermediateDir(BuildScriptGeneratorContext ctx)
{
return Array.Empty<string>();
}
/// <inheritdoc/>
public string GetInstallerScriptSnippet(
BuildScriptGeneratorContext context,
PlatformDetectorResult detectorResult)
{
var javaPlatformDetectorResult = detectorResult as JavaPlatformDetectorResult;
if (javaPlatformDetectorResult == null)
{
throw new ArgumentException(
$"Expected '{nameof(detectorResult)}' argument to be of type " +
$"'{typeof(JavaPlatformDetectorResult)}' but got '{detectorResult.GetType()}'.");
}
if (this.commonOptions.EnableDynamicInstall)
{
this.logger.LogDebug("Dynamic install is enabled.");
var scriptBuilder = new StringBuilder();
this.InstallJavaSdk(javaPlatformDetectorResult.PlatformVersion, scriptBuilder);
// We need not setup Maven if repo already uses a Maven wrapper script.
if (!javaPlatformDetectorResult.UsesMavenWrapperTool)
{
this.InstallMaven(javaPlatformDetectorResult.MavenVersion, scriptBuilder);
}
if (scriptBuilder.Length == 0)
{
return null;
}
return scriptBuilder.ToString();
}
else
{
this.logger.LogDebug("Dynamic install not enabled.");
return null;
}
}
/// <inheritdoc/>
public IDictionary<string, string> GetToolsToBeSetInPath(
RepositoryContext context,
PlatformDetectorResult detectorResult)
{
var javaPlatformDetectorResult = detectorResult as JavaPlatformDetectorResult;
if (javaPlatformDetectorResult == null)
{
throw new ArgumentException(
$"Expected '{nameof(detectorResult)}' argument to be of type " +
$"'{typeof(JavaPlatformDetectorResult)}' but got '{detectorResult.GetType()}'.");
}
var tools = new Dictionary<string, string>();
tools[JavaConstants.PlatformName] = javaPlatformDetectorResult.PlatformVersion;
if (javaPlatformDetectorResult.UsesMaven &&
!javaPlatformDetectorResult.UsesMavenWrapperTool)
{
tools[JavaConstants.MavenName] = javaPlatformDetectorResult.MavenVersion;
}
return tools;
}
/// <inheritdoc/>
public void ResolveVersions(RepositoryContext context, PlatformDetectorResult detectorResult)
{
var javaPlatformDetectorResult = detectorResult as JavaPlatformDetectorResult;
if (javaPlatformDetectorResult == null)
{
throw new ArgumentException(
$"Expected '{nameof(detectorResult)}' argument to be of type " +
$"'{typeof(JavaPlatformDetectorResult)}' but got '{detectorResult.GetType()}'.");
}
this.ResolveVersionsUsingHierarchicalRules(javaPlatformDetectorResult);
}
private void ResolveVersionsUsingHierarchicalRules(JavaPlatformDetectorResult detectorResult)
{
var javaVersion = ResolveJavaVersion(detectorResult.PlatformVersion);
javaVersion = this.GetMaxSatisfyingJavaVersionAndVerify(javaVersion);
var mavenVersion = ResolveMavenVersion(detectorResult.MavenVersion);
mavenVersion = this.GetMaxSatisfyingMavenVersionAndVerify(mavenVersion);
detectorResult.PlatformVersion = javaVersion;
detectorResult.MavenVersion = mavenVersion;
string ResolveJavaVersion(string detectedVersion)
{
// Explicitly specified version by user wins over detected version
if (!string.IsNullOrEmpty(this.javaScriptGeneratorOptions.JavaVersion))
{
return this.javaScriptGeneratorOptions.JavaVersion;
}
// If a version was detected, then use it.
if (detectedVersion != null)
{
return detectedVersion;
}
// Explicitly specified default version by user wins over detected default
if (!string.IsNullOrEmpty(this.javaScriptGeneratorOptions.JavaDefaultVersion))
{
return this.javaScriptGeneratorOptions.JavaDefaultVersion;
}
// Fallback to default version detection
var versionInfo = this.javaVersionProvider.GetVersionInfo();
return versionInfo.DefaultVersion;
}
string ResolveMavenVersion(string detectedVersion)
{
// Explicitly specified version by user wins over detected version
if (!string.IsNullOrEmpty(this.javaScriptGeneratorOptions.MavenVersion))
{
return this.javaScriptGeneratorOptions.MavenVersion;
}
// If a version was detected, then use it.
if (detectedVersion != null)
{
return detectedVersion;
}
// Explicitly specified default version by user wins over detected default
if (!string.IsNullOrEmpty(this.javaScriptGeneratorOptions.MavenDefaultVersion))
{
return this.javaScriptGeneratorOptions.MavenDefaultVersion;
}
// Fallback to default version detection
return JavaConstants.MavenVersion;
}
}
private void InstallJavaSdk(string jdkVersion, StringBuilder scriptBuilder)
{
if (this.javaPlatformInstaller.IsVersionAlreadyInstalled(jdkVersion))
{
this.logger.LogDebug(
"JDK version {version} is already installed. So skipping installing it again.",
jdkVersion);
}
else
{
this.logger.LogDebug(
"JSDK version {version} is not installed. " +
"So generating an installation script snippet for it.",
jdkVersion);
var script = this.javaPlatformInstaller.GetInstallerScriptSnippet(jdkVersion);
scriptBuilder.AppendLine(script);
}
}
private void InstallMaven(string mavenVersion, StringBuilder scriptBuilder)
{
// Install Maven
if (this.mavenInstaller.IsVersionAlreadyInstalled(mavenVersion))
{
this.logger.LogDebug(
"Maven version {version} is already installed. So skipping installing it again.",
mavenVersion);
}
else
{
this.logger.LogDebug(
"Maven version {version} is not installed. " +
"So generating an installation script snippet for it.",
mavenVersion);
var script = this.mavenInstaller.GetInstallerScriptSnippet(mavenVersion);
scriptBuilder.AppendLine(script);
}
}
private string GetMaxSatisfyingJavaVersionAndVerify(string version)
{
var versionInfo = this.javaVersionProvider.GetVersionInfo();
var maxSatisfyingVersion = SemanticVersionResolver.GetMaxSatisfyingVersion(
version,
versionInfo.SupportedVersions);
if (string.IsNullOrEmpty(maxSatisfyingVersion))
{
var exception = new UnsupportedVersionException(
JavaConstants.PlatformName,
version,
versionInfo.SupportedVersions);
this.logger.LogError(
exception,
$"Exception caught, the version '{version}' is not supported for the Java platform.");
throw exception;
}
return maxSatisfyingVersion;
}
private string GetMaxSatisfyingMavenVersionAndVerify(string version)
{
var versionInfo = this.mavenVersionProvider.GetVersionInfo();
var maxSatisfyingVersion = SemanticVersionResolver.GetMaxSatisfyingVersion(
version,
versionInfo.SupportedVersions);
if (string.IsNullOrEmpty(maxSatisfyingVersion))
{
var exception = new UnsupportedVersionException(
"maven",
version,
versionInfo.SupportedVersions);
this.logger.LogError(
exception,
$"Exception caught, the version '{version}' is not supported for Maven.");
throw exception;
}
return maxSatisfyingVersion;
}
}
}
You can’t perform that action at this time.