/
PipelineBuilder.cs
437 lines (371 loc) · 16.8 KB
/
PipelineBuilder.cs
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
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSRule.Configuration;
using PSRule.Definitions;
using PSRule.Pipeline.Output;
using PSRule.Resources;
using PSRule.Runtime;
using System;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
using System.Management.Automation;
using System.Reflection;
using System.Text;
namespace PSRule.Pipeline
{
public static class PipelineBuilder
{
public static IInvokePipelineBuilder Assert(Source[] source, PSRuleOption option, PSCmdlet commandRuntime, EngineIntrinsics executionContext)
{
var hostContext = new HostContext(commandRuntime, executionContext);
var pipeline = new AssertPipelineBuilder(source, hostContext);
pipeline.Configure(option);
return pipeline;
}
public static IInvokePipelineBuilder Invoke(Source[] source, PSRuleOption option, PSCmdlet commandRuntime, EngineIntrinsics executionContext)
{
var hostContext = new HostContext(commandRuntime, executionContext);
var pipeline = new InvokeRulePipelineBuilder(source, hostContext);
pipeline.Configure(option);
return pipeline;
}
public static IInvokePipelineBuilder Test(Source[] source, PSRuleOption option, PSCmdlet commandRuntime, EngineIntrinsics executionContext)
{
var hostContext = new HostContext(commandRuntime, executionContext);
var pipeline = new TestPipelineBuilder(source, hostContext);
pipeline.Configure(option);
return pipeline;
}
public static IGetPipelineBuilder Get(Source[] source, PSRuleOption option, PSCmdlet commandRuntime, EngineIntrinsics executionContext)
{
var hostContext = new HostContext(commandRuntime, executionContext);
var pipeline = new GetRulePipelineBuilder(source, hostContext);
pipeline.Configure(option);
return pipeline;
}
public static IHelpPipelineBuilder GetHelp(Source[] source, PSRuleOption option, PSCmdlet commandRuntime, EngineIntrinsics executionContext)
{
var hostContext = new HostContext(commandRuntime, executionContext);
var pipeline = new GetRuleHelpPipelineBuilder(source, hostContext);
pipeline.Configure(option);
return pipeline;
}
public static SourcePipelineBuilder RuleSource(PSRuleOption option, PSCmdlet commandRuntime, EngineIntrinsics executionContext)
{
var hostContext = new HostContext(commandRuntime, executionContext);
var pipeline = new SourcePipelineBuilder(hostContext, option);
return pipeline;
}
public static IPipelineBuilder GetBaseline(Source[] source, PSRuleOption option, PSCmdlet commandRuntime, EngineIntrinsics executionContext)
{
var hostContext = new HostContext(commandRuntime, executionContext);
var pipeline = new GetBaselinePipelineBuilder(source, hostContext);
pipeline.Configure(option);
return pipeline;
}
public static IGetTargetPipelineBuilder GetTarget(PSRuleOption option, PSCmdlet commandRuntime, EngineIntrinsics executionContext)
{
var hostContext = new HostContext(commandRuntime, executionContext);
var pipeline = new GetTargetPipelineBuilder(null, hostContext);
pipeline.Configure(option);
return pipeline;
}
}
public interface IPipelineBuilder
{
IPipelineBuilder Configure(PSRuleOption option);
IPipeline Build();
}
public interface IPipeline
{
void Begin();
void Process(PSObject sourceObject);
[System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1716:Identifiers should not match keywords", Justification = "Matches PowerShell pipeline.")]
void End();
}
internal abstract class PipelineBuilderBase : IPipelineBuilder
{
private const string ENGINE_MODULE_NAME = "PSRule";
protected readonly PSRuleOption Option;
protected readonly Source[] Source;
protected readonly HostContext HostContext;
protected BindTargetMethod BindTargetNameHook;
protected BindTargetMethod BindTargetTypeHook;
protected BindTargetMethod BindFieldHook;
protected VisitTargetObject VisitTargetObject;
private string[] _Include;
private Hashtable _Tag;
private BaselineOption _Baseline;
private string[] _Convention;
private readonly HostPipelineWriter _Output;
protected PipelineBuilderBase(Source[] source, HostContext hostContext)
{
Option = new PSRuleOption();
Source = source;
_Output = new HostPipelineWriter(hostContext, Option);
HostContext = hostContext;
BindTargetNameHook = PipelineHookActions.BindTargetName;
BindTargetTypeHook = PipelineHookActions.BindTargetType;
BindFieldHook = PipelineHookActions.BindField;
VisitTargetObject = PipelineReceiverActions.PassThru;
}
public void Name(string[] name)
{
if (name == null || name.Length == 0)
return;
_Include = name;
}
public void Tag(Hashtable tag)
{
if (tag == null || tag.Count == 0)
return;
_Tag = tag;
}
public void Convention(string[] convention)
{
if (convention == null || convention.Length == 0)
return;
_Convention = convention;
}
public virtual IPipelineBuilder Configure(PSRuleOption option)
{
if (option == null)
return this;
Option.Binding = new BindingOption(option.Binding);
Option.Convention = new ConventionOption(option.Convention);
Option.Execution = new ExecutionOption(option.Execution);
Option.Execution.LanguageMode = option.Execution.LanguageMode ?? ExecutionOption.Default.LanguageMode;
Option.Input = new InputOption(option.Input);
Option.Input.Format = Option.Input.Format ?? InputOption.Default.Format;
Option.Output = new OutputOption(option.Output);
Option.Output.Outcome = Option.Output.Outcome ?? OutputOption.Default.Outcome;
Option.Output.Banner = Option.Output.Banner ?? OutputOption.Default.Banner;
return this;
}
public abstract IPipeline Build();
/// <summary>
/// Use a baseline, either by name or by path.
/// </summary>
public void UseBaseline(BaselineOption baseline)
{
if (baseline == null)
return;
_Baseline = baseline;
}
/// <summary>
/// Require correct module versions for pipeline execution.
/// </summary>
protected bool RequireModules()
{
var result = true;
if (Option.Requires.TryGetValue(ENGINE_MODULE_NAME, out string requiredVersion))
{
var engineVersion = FileVersionInfo.GetVersionInfo(Assembly.GetExecutingAssembly().Location).ProductVersion;
if (GuardModuleVersion(ENGINE_MODULE_NAME, engineVersion, requiredVersion))
result = false;
}
for (var i = 0; Source != null && i < Source.Length; i++)
{
if (Source[i].Module != null && Option.Requires.TryGetValue(Source[i].Module.Name, out requiredVersion))
{
if (GuardModuleVersion(Source[i].Module.Name, Source[i].Module.Version, requiredVersion))
result = false;
}
}
return result;
}
/// <summary>
/// Require sources for pipeline execution.
/// </summary>
protected bool RequireSources()
{
if (Source == null || Source.Length == 0)
{
PrepareWriter().WarnRulePathNotFound();
return false;
}
return true;
}
private bool GuardModuleVersion(string moduleName, string moduleVersion, string requiredVersion)
{
if (!TryModuleVersion(moduleVersion, requiredVersion))
{
var writer = PrepareWriter();
writer.ErrorRequiredVersionMismatch(moduleName, moduleVersion, requiredVersion);
writer.End();
return true;
}
return false;
}
private static bool TryModuleVersion(string moduleVersion, string requiredVersion)
{
if (!(SemanticVersion.TryParseVersion(moduleVersion, out SemanticVersion.Version version) && SemanticVersion.TryParseConstraint(requiredVersion, out SemanticVersion.Constraint constraint)))
return false;
return constraint.Equals(version);
}
protected PipelineContext PrepareContext(BindTargetMethod bindTargetName, BindTargetMethod bindTargetType, BindTargetMethod bindField)
{
var unresolved = new Dictionary<string, ResourceRef>(StringComparer.OrdinalIgnoreCase);
if (_Baseline is BaselineOption.BaselineRef baselineRef)
unresolved.Add(baselineRef.Name, new BaselineRef(baselineRef.Name, OptionContext.ScopeType.Explicit));
for (var i = 0; Source != null && i < Source.Length; i++)
{
if (Source[i].Module != null && Source[i].Module.Baseline != null && !unresolved.ContainsKey(Source[i].Module.Baseline))
unresolved.Add(Source[i].Module.Baseline, new BaselineRef(Source[i].Module.Baseline, OptionContext.ScopeType.Module));
}
return PipelineContext.New(
option: Option,
hostContext: HostContext,
reader: PrepareReader(),
binder: new TargetBinder(bindTargetName, bindTargetType, bindField, Option.Input.TargetType),
baseline: GetOptionContext(),
unresolved: unresolved
);
}
protected virtual PipelineReader PrepareReader()
{
return new PipelineReader(null, null);
}
protected virtual PipelineWriter PrepareWriter()
{
var output = GetOutput();
switch (Option.Output.Format)
{
case OutputFormat.Csv:
return new CsvOutputWriter(output, Option);
case OutputFormat.Json:
return new JsonOutputWriter(output, Option);
case OutputFormat.NUnit3:
return new NUnit3OutputWriter(output, Option);
case OutputFormat.Yaml:
return new YamlOutputWriter(output, Option);
case OutputFormat.Markdown:
return new MarkdownOutputWriter(output, Option);
case OutputFormat.Wide:
return new WideOutputWriter(output, Option);
}
return output;
}
protected PipelineWriter GetOutput()
{
// Redirect to file instead
if (!string.IsNullOrEmpty(Option.Output.Path))
{
return new FileOutputWriter(
inner: _Output,
option: Option,
encoding: GetEncoding(Option.Output.Encoding),
path: Option.Output.Path,
shouldProcess: HostContext.ShouldProcess
);
}
return _Output;
}
protected static string[] GetCulture(string[] culture)
{
var result = new List<string>();
var parent = new List<string>();
var set = new HashSet<string>();
for (var i = 0; culture != null && i < culture.Length; i++)
{
var c = CultureInfo.CreateSpecificCulture(culture[i]);
if (!set.Contains(c.Name))
{
result.Add(c.Name);
set.Add(c.Name);
}
for (var p = c.Parent; !string.IsNullOrEmpty(p.Name); p = p.Parent)
{
if (!set.Contains(p.Name))
{
parent.Add(p.Name);
set.Add(p.Name);
}
}
}
if (parent.Count > 0)
result.AddRange(parent);
if (result.Count == 0)
return null;
return result.ToArray();
}
/// <summary>
/// Get the character encoding for the specified output encoding.
/// </summary>
/// <param name="encoding"></param>
/// <returns></returns>
private static Encoding GetEncoding(OutputEncoding? encoding)
{
switch (encoding)
{
case OutputEncoding.UTF8:
return Encoding.UTF8;
case OutputEncoding.UTF7:
return Encoding.UTF7;
case OutputEncoding.Unicode:
return Encoding.Unicode;
case OutputEncoding.UTF32:
return Encoding.UTF32;
case OutputEncoding.ASCII:
return Encoding.ASCII;
default:
return new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
}
}
private OptionContext GetOptionContext()
{
var result = new OptionContext();
// Baseline
var baselineScope = new OptionContext.BaselineScope(type: OptionContext.ScopeType.Workspace, baselineId: null, moduleName: null, option: Option, obsolete: false);
result.Add(baselineScope);
baselineScope = new OptionContext.BaselineScope(type: OptionContext.ScopeType.Parameter, include: _Include, tag: _Tag, convention: _Convention);
result.Add(baselineScope);
// Config
var configScope = new OptionContext.ConfigScope(type: OptionContext.ScopeType.Workspace, moduleName: null, option: Option);
result.Add(configScope);
return result;
}
protected void ConfigureBinding(PSRuleOption option)
{
if (option.Pipeline.BindTargetName != null && option.Pipeline.BindTargetName.Count > 0)
{
// Do not allow custom binding functions to be used with constrained language mode
if (Option.Execution.LanguageMode == LanguageMode.ConstrainedLanguage)
throw new PipelineConfigurationException(optionName: "BindTargetName", message: PSRuleResources.ConstrainedTargetBinding);
foreach (var action in option.Pipeline.BindTargetName)
BindTargetNameHook = AddBindTargetAction(action, BindTargetNameHook);
}
if (option.Pipeline.BindTargetType != null && option.Pipeline.BindTargetType.Count > 0)
{
// Do not allow custom binding functions to be used with constrained language mode
if (Option.Execution.LanguageMode == LanguageMode.ConstrainedLanguage)
throw new PipelineConfigurationException(optionName: "BindTargetType", message: PSRuleResources.ConstrainedTargetBinding);
foreach (var action in option.Pipeline.BindTargetType)
BindTargetTypeHook = AddBindTargetAction(action, BindTargetTypeHook);
}
}
private static BindTargetMethod AddBindTargetAction(BindTargetFunc action, BindTargetMethod previous)
{
// Nest the previous write action in the new supplied action
// Execution chain will be: action -> previous -> previous..n
return (propertyNames, caseSensitive, preferTargetInfo, targetObject) => action(propertyNames, caseSensitive, preferTargetInfo, targetObject, previous);
}
private static BindTargetMethod AddBindTargetAction(BindTargetName action, BindTargetMethod previous)
{
return AddBindTargetAction((parameterNames, caseSensitive, preferTargetInfo, targetObject, next) =>
{
var targetType = action(targetObject);
return string.IsNullOrEmpty(targetType) ? next(parameterNames, caseSensitive, preferTargetInfo, targetObject) : targetType;
}, previous);
}
protected void AddVisitTargetObjectAction(VisitTargetObjectAction action)
{
// Nest the previous write action in the new supplied action
// Execution chain will be: action -> previous -> previous..n
var previous = VisitTargetObject;
VisitTargetObject = (targetObject) => action(targetObject, previous);
}
}
}