FilesExpand file tree

develop

/

ScriptRunner.cs

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

224 lines (195 loc) · 8.17 KB

develop

/

ScriptRunner.cs

Copy path

Top

File metadata and controls

• Code
• Blame

224 lines (195 loc) · 8.17 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

// Licensed to the .NET Foundation under one or more agreements.

// The .NET Foundation licenses this file to you under the MIT license.

// See the LICENSE file in the project root for more information.

using System;

using System.Collections.Generic;

using System.Linq;

using System.Reflection;

using Cake.Core.Configuration;

using Cake.Core.Diagnostics;

using Cake.Core.IO;

using Cake.Core.Reflection;

using Cake.Core.Scripting.Analysis;

namespace Cake.Core.Scripting;

/// <summary>

/// Responsible for running scripts.

/// </summary>

public sealed class ScriptRunner : IScriptRunner

{

private readonly ICakeEnvironment _environment;

private readonly ICakeLog _log;

private readonly ICakeConfiguration _configuration;

private readonly IScriptEngine _engine;

private readonly IScriptAliasFinder _aliasFinder;

private readonly IScriptAnalyzer _analyzer;

private readonly IScriptProcessor _processor;

private readonly IScriptConventions _conventions;

private readonly IAssemblyLoader _assemblyLoader;

/// <summary>

/// Initializes a new instance of the <see cref="ScriptRunner"/> class.

/// </summary>

/// <param name="environment">The environment.</param>

/// <param name="log">The log.</param>

/// <param name="configuration">The configuration.</param>

/// <param name="engine">The session factory.</param>

/// <param name="aliasFinder">The alias finder.</param>

/// <param name="analyzer">The script analyzer.</param>

/// <param name="processor">The script processor.</param>

/// <param name="conventions">The script conventions.</param>

/// <param name="assemblyLoader">The assembly loader.</param>

public ScriptRunner(

ICakeEnvironment environment,

ICakeLog log,

ICakeConfiguration configuration,

IScriptEngine engine,

IScriptAliasFinder aliasFinder,

IScriptAnalyzer analyzer,

IScriptProcessor processor,

IScriptConventions conventions,

IAssemblyLoader assemblyLoader)

{

_environment = environment ?? throw new ArgumentNullException(nameof(environment));

_log = log ?? throw new ArgumentNullException(nameof(log));

_configuration = configuration ?? throw new ArgumentNullException(nameof(configuration));

_engine = engine ?? throw new ArgumentNullException(nameof(engine));

_aliasFinder = aliasFinder ?? throw new ArgumentNullException(nameof(aliasFinder));

_analyzer = analyzer ?? throw new ArgumentNullException(nameof(analyzer));

_processor = processor ?? throw new ArgumentNullException(nameof(processor));

_conventions = conventions ?? throw new ArgumentNullException(nameof(conventions));

_assemblyLoader = assemblyLoader ?? throw new ArgumentNullException(nameof(assemblyLoader));

}

/// <inheritdoc/>

public void Run(IScriptHost host, FilePath scriptPath)

{

ArgumentNullException.ThrowIfNull(host);

ArgumentNullException.ThrowIfNull(scriptPath);

// Make the script path absolute.

scriptPath = scriptPath.MakeAbsolute(_environment);

// Prepare the environment.

_environment.WorkingDirectory = scriptPath.GetDirectory();

// Analyze the script file.

_log.Verbose("Analyzing build script...");

var result = _analyzer.Analyze(scriptPath.GetFilename(), new ScriptAnalyzerSettings());

// Log all errors and throw

if (!result.Succeeded)

{

foreach (var error in result.Errors)

{

var format = $"{error.File.MakeAbsolute(_environment).FullPath}:{error.Line}: {{0}}";

_log.Error(format, error.Message);

}

throw new CakeException("Errors occurred while analyzing script.");

}

// Install tools.

_log.Verbose("Processing build script...");

var toolsPath = GetToolPath(scriptPath.GetDirectory());

_processor.InstallTools(result.Tools, toolsPath);

// Install addins.

var addinRoot = GetAddinPath(scriptPath.GetDirectory());

var addinReferences = _processor.InstallAddins(result.Addins, addinRoot);

foreach (var addinReference in addinReferences)

{

result.References.Add(addinReference.FullPath);

}

// Create and prepare the session.

var session = _engine.CreateSession(host);

// Load all references.

var applicationRoot = _environment.ApplicationRoot;

var assemblies = new HashSet<Assembly>();

assemblies.AddRange(_conventions.GetDefaultAssemblies(applicationRoot));

foreach (var moduleAssembly in GetModuleAssemblies(host, scriptPath.GetDirectory()))

{

assemblies.Add(moduleAssembly);

}

foreach (var reference in result.References)

{

var referencePath = new FilePath(reference);

if (host.Context.FileSystem.Exist(referencePath))

{

var assembly = _assemblyLoader.Load(referencePath, true);

if (assembly != null)

{

assemblies.Add(assembly);

}

}

else

{

// Add a reference to the session.

session.AddReference(referencePath);

}

}

var aliases = new List<ScriptAlias>();

// Got any assemblies?

if (assemblies.Count > 0)

{

// Find all script aliases.

var foundAliases = _aliasFinder.FindAliases(assemblies);

if (foundAliases.Count > 0)

{

aliases.AddRange(foundAliases);

}

// Add assembly references to the session.

foreach (var assembly in assemblies)

{

session.AddReference(assembly);

}

}

// Import all namespaces.

var namespaces = new HashSet<string>(result.Namespaces, StringComparer.Ordinal);

namespaces.AddRange(_conventions.GetDefaultNamespaces());

namespaces.AddRange(aliases.SelectMany(alias => alias.Namespaces));

foreach (var @namespace in namespaces.OrderBy(ns => ns))

{

session.ImportNamespace(@namespace);

}

var defines = new HashSet<string>(result.Defines, StringComparer.Ordinal);

defines.AddRange(_conventions.GetDefaultDefines());

// Execute the script.

var script = new Script(result.Namespaces, result.Lines, aliases, result.UsingAliases, result.UsingStaticDirectives, defines);

session.Execute(script);

}

private DirectoryPath GetToolPath(DirectoryPath root)

{

var toolPath = _configuration.GetValue(Constants.Paths.Tools);

if (!string.IsNullOrWhiteSpace(toolPath))

{

return new DirectoryPath(toolPath).MakeAbsolute(_environment).ExpandShortPath();

}

return root.Combine("tools").ExpandShortPath();

}

private DirectoryPath GetAddinPath(DirectoryPath root)

{

var addinPath = _configuration.GetValue(Constants.Paths.Addins);

if (!string.IsNullOrWhiteSpace(addinPath))

{

return new DirectoryPath(addinPath).MakeAbsolute(_environment).ExpandShortPath();

}

var toolPath = GetToolPath(root).ExpandShortPath();

return toolPath.Combine("Addins").Collapse();

}

private IEnumerable<Assembly> GetModuleAssemblies(IScriptHost host, DirectoryPath root)

{

var modulePath = Cake.Core.CakeConfigurationExtensions.GetModulePath(_configuration, root, _environment);

var moduleDirectory = host.Context.FileSystem.GetDirectory(modulePath);

if (!moduleDirectory.Exists)

{

yield break;

}

foreach (var file in moduleDirectory.GetFiles("Cake.*.Module.dll", SearchScope.Recursive))

{

Assembly assembly = null;

try

{

assembly = _assemblyLoader.Load(file.Path, true);

}

catch (Exception ex)

{

_log.Warning("Could not load module assembly '{0}'. {1}", file.Path.FullPath, ex.Message);

}

if (assembly != null)

{

yield return assembly;

}

}

}

}