-
Notifications
You must be signed in to change notification settings - Fork 20
Expand file tree
/
Copy pathCliCommand.cs
More file actions
223 lines (208 loc) · 6.73 KB
/
CliCommand.cs
File metadata and controls
223 lines (208 loc) · 6.73 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
using System.Diagnostics;
using System.Text;
namespace BytecodeApi.IO;
/// <summary>
/// Class to start processes and retrieve exit code and console output.
/// </summary>
public sealed class CliCommand
{
private string _FileName = null!;
private string? _Arguments;
private string? _WorkingDirectory;
private bool _UseShellExecute;
private bool _Elevated;
private bool _Hidden;
private CliCommand()
{
}
/// <summary>
/// Specifies the file to be executed.
/// </summary>
/// <param name="fileName">The full path to the file to be executed.</param>
/// <returns>
/// A reference to this instance after the operation has completed.
/// </returns>
public static CliCommand FileName(string fileName)
{
Check.ArgumentNull(fileName);
return new()
{
_FileName = fileName
};
}
/// <summary>
/// Specifies arguments to pass to the executed process.
/// </summary>
/// <param name="arguments">Commandline arguments to pass to the executed process.</param>
/// <returns>
/// A reference to this instance after the operation has completed.
/// </returns>
public CliCommand Arguments(string arguments)
{
Check.ArgumentNull(arguments);
_Arguments = arguments;
return this;
}
/// <summary>
/// Specifies arguments to pass to the executed process.
/// </summary>
/// <param name="arguments">Commandline arguments to pass to the executed process.</param>
/// <returns>
/// A reference to this instance after the operation has completed.
/// </returns>
public CliCommand Arguments(params string[] arguments)
{
Check.ArgumentNull(arguments);
Check.ArgumentEx.ArrayValuesNotNull(arguments);
_Arguments = CommandLine.FromArguments(arguments);
return this;
}
/// <summary>
/// Specifies the working directory of the executed process.
/// </summary>
/// <param name="workingDirectory">The working directory of the executed process.</param>
/// <returns>
/// A reference to this instance after the operation has completed.
/// </returns>
public CliCommand WorkingDirectory(string workingDirectory)
{
Check.ArgumentNull(workingDirectory);
_WorkingDirectory = workingDirectory;
return this;
}
/// <summary>
/// Specifies to use ShellExecute during process creation. Console output will not be read.
/// </summary>
/// <returns>
/// A reference to this instance after the operation has completed.
/// </returns>
public CliCommand UseShellExecute()
{
_UseShellExecute = true;
return this;
}
/// <summary>
/// Specifies that the process will be started with elevated privileges. This option is only valid with UseShellExecute.
/// </summary>
/// <returns>
/// A reference to this instance after the operation has completed.
/// </returns>
public CliCommand Elevated()
{
_Elevated = true;
return this;
}
/// <summary>
/// Specifies that the window of the process is hidden.
/// </summary>
/// <returns>
/// A reference to this instance after the operation has completed.
/// </returns>
public CliCommand Hidden()
{
_Hidden = true;
return this;
}
/// <summary>
/// Executes this <see cref="CliCommand" /> and returns a <see cref="CliResult" /> object with the result.
/// </summary>
/// <returns>
/// A <see cref="CliResult" /> object with the result.
/// </returns>
public CliResult Execute()
{
return Execute(Timeout.Infinite)!;
}
/// <summary>
/// Executes this <see cref="CliCommand" /> and returns a <see cref="CliResult" /> object with the result, or <see langword="null" />, if the operation timed out.
/// </summary>
/// <param name="timeout">The amount of time to wait for the process to exit.</param>
/// <returns>
/// A <see cref="CliResult" /> object with the result, or <see langword="null" />, if the operation timed out.
/// </returns>
public CliResult? Execute(TimeSpan timeout)
{
return Execute((int)timeout.TotalMilliseconds);
}
/// <summary>
/// Executes this <see cref="CliCommand" /> and returns a <see cref="CliResult" /> object with the result, or <see langword="null" />, if the operation timed out.
/// </summary>
/// <param name="timeout">The amount of time, in milliseconds, to wait for the process to exit.</param>
/// <returns>
/// A <see cref="CliResult" /> object with the result, or <see langword="null" />, if the operation timed out.
/// </returns>
public CliResult? Execute(int timeout)
{
Check.Argument(!_Elevated || _UseShellExecute, null, "Elevated can only be used with UseShellExecute.");
StringBuilder output = new();
DateTime startTime = DateTime.Now;
using Process process = new()
{
StartInfo =
{
FileName = _FileName,
Arguments = _Arguments,
WorkingDirectory = _WorkingDirectory,
UseShellExecute = _UseShellExecute,
Verb = _Elevated ? "runas" : "",
RedirectStandardOutput = !_UseShellExecute,
RedirectStandardError = !_UseShellExecute,
CreateNoWindow = _Hidden,
WindowStyle = _Hidden ? ProcessWindowStyle.Hidden : ProcessWindowStyle.Normal
},
EnableRaisingEvents = true
};
process.OutputDataReceived += DataReceived;
process.ErrorDataReceived += DataReceived;
process.Start();
if (!_UseShellExecute)
{
process.BeginOutputReadLine();
process.BeginErrorReadLine();
}
if (process.WaitForExit(timeout))
{
return new(process.ExitCode, output.ToString(), startTime, DateTime.Now);
}
else
{
return null;
}
void DataReceived(object sender, DataReceivedEventArgs e)
{
output.AppendLine(e.Data);
}
}
/// <summary>
/// Executes this <see cref="CliCommand" /> and returns a <see cref="CliResult" /> object with the result.
/// </summary>
/// <returns>
/// A <see cref="CliResult" /> object with the result.
/// </returns>
public Task<CliResult> ExecuteAsync()
{
return ExecuteAsync(Timeout.Infinite)!;
}
/// <summary>
/// Executes this <see cref="CliCommand" /> and returns a <see cref="CliResult" /> object with the result, or <see langword="null" />, if the operation timed out.
/// </summary>
/// <param name="timeout">The amount of time to wait for the process to exit.</param>
/// <returns>
/// A <see cref="CliResult" /> object with the result, or <see langword="null" />, if the operation timed out.
/// </returns>
public Task<CliResult?> ExecuteAsync(TimeSpan timeout)
{
return ExecuteAsync((int)timeout.TotalMilliseconds);
}
/// <summary>
/// Executes this <see cref="CliCommand" /> and returns a <see cref="CliResult" /> object with the result, or <see langword="null" />, if the operation timed out.
/// </summary>
/// <param name="timeout">The amount of time, in milliseconds, to wait for the process to exit.</param>
/// <returns>
/// A <see cref="CliResult" /> object with the result, or <see langword="null" />, if the operation timed out.
/// </returns>
public async Task<CliResult?> ExecuteAsync(int timeout)
{
return await Task.Run(() => Execute(timeout));
}
}