chr
2026-04-05 fe750b791d5b517cc4e9bc8e99a9a75139a0cfba
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
using System;
using System.IO;
using System.Linq;
using System.Reflection.Metadata;
using System.Reflection.PortableExecutable;
using System.Text.RegularExpressions;
 
namespace OpenTap.Engine.UnitTests.TestTestSteps
{
    [Display("Write File", Description: "Writes a string to a file.", Group: "Tests")]
    public class WriteFileStep : TestStep
    {
        [Layout(LayoutMode.Normal, rowHeight: 5)]
        public string String { get; set; }
        public string File { get; set; }
        public override void Run() => System.IO.File.WriteAllText(File, String);
    }
 
    [Display("Create Directory", Description: "Creates a new directory.", Group: "Tests")]
    public class CreateDirectoryStep : TestStep
    {
        public string Directory { get; set; }
        public override void Run()
        {
            System.IO.Directory.CreateDirectory(Directory);
        }
    }
 
    [Display("Replace In File", Description: "Replaces some text in a file.", Group: "Tests")]
    public class ReplaceInFileStep : TestStep
    {
        [FilePath]
        [Display("File", Order: 0)]
        public string File { get; set;}
        [Layout(LayoutMode.Normal, rowHeight: 5)]
        [Display("Search For", Order: 1)]
        public string Search { get; set; }
        [Layout(LayoutMode.Normal, rowHeight: 5)]
        [Display("Replace With", Order: 2)]
        public string Replace { get; set; }
 
        public override void Run()
        {
            var content = System.IO.File.ReadAllText(File);
            content = content.Replace(Search, Replace);
            System.IO.File.WriteAllText(File, content);
        }
    }
 
    [Display("Expect", Description: "Expects  verdict in the child step.", Group: "Tests")]
    [AllowAnyChild]
    public class ExpectStep : TestStep
    {
        public Verdict ExpectedVerdict { get; set; }
        public override void Run()
        {
            RunChildSteps();
            if (Verdict == ExpectedVerdict)
                Verdict = Verdict.Pass;
            else
            {
                Verdict = Verdict.Fail;
            }
        }
    }
 
    public enum VersionType
    {
        FileVersion,
        SemanticVersion
    }
 
    [Display("Read Assembly Version", Group: "Tests")]
    public class ReadAssemblyVersionStep : TestStep
    {
        [FilePath]
        public string File { get; set; }
        
        public string MatchVersion { get; set; }
        public VersionType VersionType { get; set; }
 
        void CheckFileVersion()
        {
            var semver = GetVersion(File);
            if (semver == null)
            {
                Log.Error("Unable to read version info.");
            }
 
            if (string.IsNullOrWhiteSpace(MatchVersion) == false)
            {
                if (Equals(semver.ToString(), MatchVersion))
                {
                    UpgradeVerdict(Verdict.Pass);
                }
                else
                {
                    UpgradeVerdict(Verdict.Fail);
                }
            }
            Log.Info("Read Version {0}", semver.ToString());
            
        }
 
        void CheckSemanticVersion()
        {
            if (!SemanticVersion.TryParse(MatchVersion, out var semver))
            {
                Log.Error($"{MatchVersion} is not a semantic version.");
                UpgradeVerdict(Verdict.Error);
                return;
            }
            
            var s = PluginManager.GetSearcher();
            s.AddAssembly(File, null);
 
            string normalize(string s)
            {
                return Path.GetFullPath(s).TrimEnd('/', '\\');
            }
 
            var nf = normalize(File);
            var asm = s.Assemblies.FirstOrDefault(a => normalize(a.Location).Equals(nf, StringComparison.OrdinalIgnoreCase));
 
            if (asm == null)
            {
                Log.Error("Assembly not loaded.");
                UpgradeVerdict(Verdict.Error);
                return;
            }
 
            var asmVer = asm.SemanticVersion;
 
            if (Equals(asmVer.ToString(), semver.ToString()))
            {
                UpgradeVerdict(Verdict.Pass);
            }
            else
            {
                UpgradeVerdict(Verdict.Fail);
            }
            Log.Info("Read Version {0}", asmVer.ToString());
        }
 
        public override void Run()
        {
            if (false == System.IO.File.Exists(File))
                throw new FileNotFoundException("File does not exist", File);
 
            switch (VersionType)
            {
                case VersionType.FileVersion:
                    CheckFileVersion();
                    break;
                case VersionType.SemanticVersion:
                    CheckSemanticVersion();
                    break;
                default:
                    throw new ArgumentOutOfRangeException();
            }
        }
 
        public static SemanticVersion GetVersion(string path)
        {
            var searcher = new PluginSearcher();
            searcher.Search(new[] {path});
            Log.Debug("Searching {0}", path);
            var asm = searcher.Assemblies.First();
            using (FileStream file = new FileStream(asm.Location, FileMode.Open, FileAccess.Read))
            using (PEReader header = new PEReader(file, PEStreamOptions.LeaveOpen))
            {
                var CurrentReader = header.GetMetadataReader();
                Log.Debug("Opened file");
                foreach (CustomAttributeHandle attrHandle in CurrentReader.GetAssemblyDefinition().GetCustomAttributes())
                {
                    
                    CustomAttribute attr = CurrentReader.GetCustomAttribute(attrHandle);
                    Log.Info("attribute: {0}",attr.Constructor.Kind);
                    if (attr.Constructor.Kind == HandleKind.MemberReference)
                    {
                        var ctor = CurrentReader.GetMemberReference((MemberReferenceHandle) attr.Constructor);
                        string attributeFullName = "";
                        if (ctor.Parent.Kind == HandleKind.TypeDefinition)
                        {
                            var def = CurrentReader.GetTypeDefinition((TypeDefinitionHandle)ctor.Parent);
                            attributeFullName = string.Format("{0}.{1}", CurrentReader.GetString(def.Namespace), CurrentReader.GetString(def.Name));
                        }
                        if (ctor.Parent.Kind == HandleKind.TypeReference)
                        {
                            var r = CurrentReader.GetTypeReference((TypeReferenceHandle)ctor.Parent);
                            attributeFullName = string.Format("{0}.{1}", CurrentReader.GetString(r.Namespace), CurrentReader.GetString(r.Name));
                        }
                        Log.Info("Found attribute: {0}", attributeFullName);
 
                        if (attributeFullName == typeof(System.Reflection.AssemblyInformationalVersionAttribute).FullName)
                        {
                            var valueString = attr.DecodeValue(new CustomAttributeTypeProvider());
                            if (SemanticVersion.TryParse(valueString.FixedArguments[0].Value.ToString(), out SemanticVersion infoVer))
                                return infoVer;
                        }
                    }
                }
            }
            Log.Warning("No Version found");
            return null;
        }
 
        struct CustomAttributeTypeProvider : ICustomAttributeTypeProvider<TypeData>
        {
            public TypeData GetPrimitiveType(PrimitiveTypeCode typeCode){return null;}
            public TypeData GetTypeFromDefinition(MetadataReader reader, TypeDefinitionHandle handle, byte rawTypeKind){return null;}
            public TypeData GetTypeFromReference(MetadataReader reader, TypeReferenceHandle handle, byte rawTypeKind){return null;}
            public TypeData GetSZArrayType(TypeData elementType){return null;}
            public TypeData GetSystemType(){return null;}
            public bool IsSystemType(TypeData type){throw new System.NotImplementedException();}
            public TypeData GetTypeFromSerializedName(string name){return null;}
            public PrimitiveTypeCode GetUnderlyingEnumType(TypeData type){throw new System.NotImplementedException();}
        }
    }
 
    [Display("Remove Directory", "Removes a directory.", "Tests")]
    public class RemoveDirectory : TestStep
    {
        [DirectoryPath]
        public string Path { get; set; }
        public override void Run()
        {
            if (Directory.Exists(Path))
                Directory.Delete(Path, true);
        }
    }
 
    
    [AllowAnyChild]
    [Display("Run On OS", "Runs the child steps on a specific OS.", "Tests")]
    public class RunOnOs : TestStep
    {
 
        public string[] AvailableOperatingSystems => new []{ "MacOS", "Linux", "Windows"};
 
        [AvailableValues(nameof(AvailableOperatingSystems))]
        public string OperatingSystem { get; set; } = "Windows";
        
        public RunOnOs()
        {
            this.Name = "Run On {OperatingSystem}";
        }
        
        public override void Run()
        {
            if (OpenTap.OperatingSystem.Current.Name == OperatingSystem)
            {
                RunChildSteps();
            }
            else
            {
                Log.Info("Skipping Child Steps On {0}", OpenTap.OperatingSystem.Current);
            }
        }
    }
 
    [Display("Find File Step", "Finds a file in a dir. Pass when found, fail if not.", "Tests")]
    public class FindFileStep : TestStep
    {
        [DirectoryPath] public MacroString SearchDir { get; set; } = new MacroString {Text = "."};
 
        public string Regex { get; set; } = "\\.zip";
 
        public override void Run()
        {
            var dir = SearchDir.Expand(this.PlanRun);
            var regex = new Regex(Regex);
            foreach(var file in Directory.GetFiles(dir))
            {
                
                if (regex.IsMatch(file))
                {
                    Log.Debug("Matched file: {0}", file);
                    UpgradeVerdict(Verdict.Pass);
                    return;
                }
            }
            UpgradeVerdict(Verdict.Fail);
        }
    }
}