ValidationTests.cs 18.8 KB
Newer Older
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 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.Emit;
using Mono.Cecil;
using Stratis.SmartContracts.CLR.Validation.Policy;
using Stratis.SmartContracts.CLR.Validation.Validators;
using Stratis.SmartContracts.CLR.Validation.Validators.Type;
using Xunit;

namespace Stratis.SmartContracts.CLR.Validation.Tests
{
    public class ValidationTests
    {
        // TypePolicyValidator

        [Fact]
        public void TypeDefValidator_Should_Validate_Method_Allowed_Return_Type()
        {
            const string source = @"public class Test {public string A(){return ""a"";}}";

            var typeDefinition = CompileToTypeDef(source);

            var policy = new WhitelistPolicy()
                .Namespace("System", AccessPolicy.Denied, t =>
                    t.Type("Object", AccessPolicy.Allowed)
                      .Type("Void", AccessPolicy.Allowed)
                      .Type("String", AccessPolicy.Allowed));

            var validationPolicy = new ValidationPolicy()
                .WhitelistValidator(policy);

            var validator = new TypePolicyValidator(validationPolicy);

            var result = validator.Validate(typeDefinition).ToList();

            Assert.Empty(result);
        }

        [Fact]
        public void TypeDefValidator_Should_Validate_Method_Denied_Return_Type()
        {
            const string source = @"using System; public class Test {public DateTime A(){return new DateTime();}}";

            var typeDefinition = CompileToTypeDef(source);

            var policy = new WhitelistPolicy()
                .Namespace("System", AccessPolicy.Denied, t =>
                    t.Type("Object", AccessPolicy.Allowed)
                        .Type("Void", AccessPolicy.Allowed)
                        .Type("String", AccessPolicy.Denied));

            var validationPolicy = new ValidationPolicy()
                .WhitelistValidator(policy);

            var validator = new TypePolicyValidator(validationPolicy);

            var result = validator.Validate(typeDefinition).ToList();

            Assert.Single(result);
        }

        [Fact]
        public void TypeDefValidator_Should_Validate_Method_Using_Denied_MethodReference()
        {
            const string source = @"public class Test {public void A(){ var b = GetType();}}";

            var typeDefinition = CompileToTypeDef(source);

            var policy = new WhitelistPolicy()
                .Namespace("System", AccessPolicy.Denied, t =>
                    t.Type("Object", AccessPolicy.Allowed)
                        .Type("Void", AccessPolicy.Allowed)
                        .Type("String", AccessPolicy.Denied));

            var validationPolicy = new ValidationPolicy()
                .WhitelistValidator(policy);

            var validator = new TypePolicyValidator(validationPolicy);

            var result = validator.Validate(typeDefinition).ToList();

            Assert.Single(result);
        }

        [Fact]
        public void TypeDefValidator_Should_Validate_Method_Using_Denied_New_Type()
        {
            const string source = @"
using System; 
public class Test 
{
    public void A()
    { 
        var b = new DateTime();
    }
}";

            var typeDefinition = CompileToTypeDef(source);

            var policy = new WhitelistPolicy()
                .Namespace("System", AccessPolicy.Denied, t =>
                    t.Type("Object", AccessPolicy.Allowed)
                        .Type("Void", AccessPolicy.Allowed)
                        .Type("String", AccessPolicy.Denied));

            var validationPolicy = new ValidationPolicy()
                .WhitelistValidator(policy);

            var validator = new TypePolicyValidator(validationPolicy);

            var result = validator.Validate(typeDefinition).ToList();

            Assert.Single(result);
        }

        [Fact]
        public void TypeDefValidator_Should_Validate_Method_Using_Denied_Field()
        {
            const string source = @"
using System; 

public class Test 
{
    public void A()
    { 
        var b = BitConverter.IsLittleEndian;
    }
}";

            var typeDefinition = CompileToTypeDef(source);

            var policy = new WhitelistPolicy()
                .Namespace("System", AccessPolicy.Denied, t =>
                    t.Type(nameof(Boolean), AccessPolicy.Allowed)
                        .Type(nameof(BitConverter), AccessPolicy.Allowed, 
                            m => m.Member(nameof(BitConverter.IsLittleEndian), AccessPolicy.Denied))
                        .Type("Object", AccessPolicy.Allowed)
                        .Type("Void", AccessPolicy.Allowed)
                        .Type("String", AccessPolicy.Denied));

            var validationPolicy = new ValidationPolicy()
                .WhitelistValidator(policy);

            var validator = new TypePolicyValidator(validationPolicy);

            var result = validator.Validate(typeDefinition).ToList();

            Assert.Single(result);
        }

        [Fact]
        public void TypeDefValidator_Should_Validate_Method_Using_Denied_Generic()
        {
            const string source = @"
using System; 
using System.Collections.Generic;

public class Test 
{
    public void A()
    { 
        var b = new List<string>();
    }
}";

            var typeDefinition = CompileToTypeDef(source);

            var policy = new WhitelistPolicy()
                .Namespace("System", AccessPolicy.Denied, t =>
                    t.Type(nameof(Boolean), AccessPolicy.Allowed)
                        .Type("Object", AccessPolicy.Allowed)
                        .Type("Void", AccessPolicy.Allowed)
                        .Type("String", AccessPolicy.Denied))
                .Namespace("System.Collections.Generic", AccessPolicy.Allowed);

            var validationPolicy = new ValidationPolicy()
                .WhitelistValidator(policy);

            var validator = new TypePolicyValidator(validationPolicy);

            var result = validator.Validate(typeDefinition).ToList();

            Assert.Single(result);
        }

        [Fact]
        public void TypeDefValidator_Should_Validate_Method_Using_Denied_Nested_Generic()
        {
            const string source = @"
using System; 
using System.Collections.Generic;

public class Test 
{
    public void A()
    { 
        var b = new List<List<string>>();
    }
}";

            var typeDefinition = CompileToTypeDef(source);

            var policy = new WhitelistPolicy()
                .Namespace("System", AccessPolicy.Denied, t =>
                    t.Type(nameof(Boolean), AccessPolicy.Allowed)
                        .Type("Object", AccessPolicy.Allowed)
                        .Type("Void", AccessPolicy.Allowed)
                        .Type("String", AccessPolicy.Denied))
                .Namespace("System.Collections.Generic", AccessPolicy.Allowed);

            var validationPolicy = new ValidationPolicy()
                .WhitelistValidator(policy);

            var validator = new TypePolicyValidator(validationPolicy);

            var result = validator.Validate(typeDefinition).ToList();

            Assert.Single(result);
        }

        [Fact]
        public void TypeDefValidator_Should_Validate_Method_Using_Denied_Nested_Array_Element()
        {
            const string source = @"
using System; 
using System.Collections.Generic;

public class Test 
{
    public void A()
    { 
        var b = new [] { new [] { ""a"" } };
    }
}";

            var typeDefinition = CompileToTypeDef(source);            

            var policy = new WhitelistPolicy()
                .Namespace("System", AccessPolicy.Denied, t =>
                    t.Type(nameof(Boolean), AccessPolicy.Allowed)
                        .Type("Object", AccessPolicy.Allowed)
                        .Type("Void", AccessPolicy.Allowed)
                        .Type("String", AccessPolicy.Denied))
                .Namespace("System.Collections.Generic", AccessPolicy.Allowed);

            var validationPolicy = new ValidationPolicy()
                .WhitelistValidator(policy);

            var validator = new TypePolicyValidator(validationPolicy);

            var result = validator.Validate(typeDefinition).ToList();
            Assert.True(result.All(r => r is WhitelistValidator.DeniedTypeValidationResult));
        }

        [Fact]
        public void TypeDefValidator_Should_Validate_Nested_Type()
        {
            const string source = @"
using System; 

public class Test 
{
    public class C {
        public void A() {
            var b = new DateTime();
        }
    }
}";

            var typeDefinition = CompileToTypeDef(source);

            var policy = new WhitelistPolicy()
                .Namespace("System", AccessPolicy.Denied, t =>
                    t.Type("Object", AccessPolicy.Allowed)
                        .Type("Void", AccessPolicy.Allowed)
                        .Type("String", AccessPolicy.Denied));

            var validationPolicy = new ValidationPolicy()
                .WhitelistValidator(policy);

            var validator = new TypePolicyValidator(validationPolicy);

            var result = validator.Validate(typeDefinition).ToList();

            Assert.Single(result);
        }

        [Fact]
        public void TypeDefValidator_Should_Allow_References_To_Own_Methods()
        {
            const string source = @"
using System; 

public class Test 
{
    public void A() {
    }

    public void B() {
        A();
    }
}";

            var typeDefinition = CompileToTypeDef(source);

            var policy = new WhitelistPolicy()
                .Namespace("System", AccessPolicy.Denied, t =>
                    t.Type("Object", AccessPolicy.Allowed)
                        .Type("Void", AccessPolicy.Allowed)
                        .Type("String", AccessPolicy.Denied));

            var validationPolicy = new ValidationPolicy()
                .WhitelistValidator(policy);

            var validator = new TypePolicyValidator(validationPolicy);

            var result = validator.Validate(typeDefinition).ToList();

            Assert.Empty(result);
        }

        //

        [Fact]
        public void NestedTypesAreValueTypesValidator_Should_Allow_Nested_Value_Type()
        {
            const string source = @"public class Test {public struct A{}}";

            var typeDefinition = CompileToTypeDef(source);

            var validator = new NestedTypesAreValueTypesValidator();

            var result = validator.Validate(typeDefinition).ToList();

            Assert.Empty(result);
        }
        
        [Fact]
        public void NestedTypesAreValueTypesValidator_Should_Not_Allow_Nested_Reference_Type()
        {
            const string source = @"public class Test{class A {} }";

            var typeDefinition = CompileToTypeDef(source);

            var validator = new NestedTypesAreValueTypesValidator();
           
            var result = validator.Validate(typeDefinition).ToList();

            Assert.Single(result);
            Assert.IsType<NestedTypesAreValueTypesValidator.NestedTypeIsValueTypeValidationResult>(result.Single());
        }

        [Fact]
        public void TypeHasMethodsValidator_Should_Validate_Type_Has_Methods()
        {
            const string source = @"public class Test{ int A(){ return 1; } void B(){} string C(){ return ""a"";} }";

            var typeDefinition = CompileToTypeDef(source);

            var validator = new TypeHasMethodsValidator();

            var result = validator.Validate(typeDefinition).ToList();

            Assert.Single(result);
            Assert.True(result.All(r => r is TypeHasMethodsValidator.TypeHasMethodsValidationResult));
        }

        [Fact] 
        public void TypeHasNestedTypesValidator_Should_Validate_Type_Has_Nested_Types_Class()
        {
            const string source = @"public class Test{ public class A {} }";

            var typeDefinition = CompileToTypeDef(source);

            var validator = new TypeHasNestedTypesValidator();

            var result = validator.Validate(typeDefinition).ToList();

            Assert.Single(result);
            Assert.True(result.All(r => r is TypeHasNestedTypesValidator.TypeHasNestedTypesValidationResult));
        }

        [Fact]
        public void TypeHasNestedTypesValidator_Should_Validate_Type_Has_Nested_Types_Struct()
        {
            const string source = @"public class Test{ public struct A {} }";

            var typeDefinition = CompileToTypeDef(source);

            var validator = new TypeHasNestedTypesValidator();

            var result = validator.Validate(typeDefinition).ToList();

            Assert.Single(result);
            Assert.True(result.All(r => r is TypeHasNestedTypesValidator.TypeHasNestedTypesValidationResult));
        }

        [Fact]
        public void FieldDefinitionValidator_Should_Validate_Type_Has_Fields()
        {
            const string source = @"public class Test{ public string A; public int B; private int C; uint D; }";

            var typeDefinition = CompileToTypeDef(source);

            var validator = new FieldDefinitionValidator();

            var result = validator.Validate(typeDefinition).ToList();

            Assert.Equal(4, result.Count);
            Assert.True(result.All(r => r is FieldDefinitionValidator.FieldDefinitionValidationResult));
        }

        

        [Fact]
        public void StaticConstructorValidator_Should_Validate_Static_Constructor()
        {
            const string source = @"public class Test { static Test(){} }";

            var typeDefinition = CompileToTypeDef(source);

            var result = new StaticConstructorValidator().Validate(typeDefinition).ToList();

            Assert.Single(result);
            Assert.IsType<StaticConstructorValidator.StaticConstructorValidationResult>(result.Single());
        }

        [Fact]
        public void MethodParamValidator_Should_Validate_Allowed_Params()
        {
            const string source = @"using Stratis.SmartContracts; public class Test { 
                                                public void Bool(bool param){}
                                                public void Byte(byte param){}
                                                public void ByteArray(byte[] param){}
                                                public void Char(char param){}
                                                public void String(string param){}
                                                public void Int32(int param){}
                                                public void UInt32(uint param){}
                                                public void UInt64(ulong param){}
                                                public void Int64(long param){}
                                                public void Address1(Address param){}
            }";

            var typeDefinition = CompileToTypeDef(source);

            foreach (var methodDefinition in typeDefinition.Methods)
            {
                var result = new MethodParamValidator().Validate(methodDefinition).ToList();
                Assert.Empty(result);
            }
        }

        [Fact]
        public void MethodParamValidator_Should_Validate_Disallowed_Params()
        {
            const string source = @"using System; public class Test { 
                                                public void DateTime1(DateTime param){}
                                                public void F(float param){}
            }";

            var typeDefinition = CompileToTypeDef(source);

            foreach (var methodDefinition in typeDefinition.Methods)
            {
                var result = new MethodParamValidator().Validate(methodDefinition).ToList();
                Assert.True(result.All(r => r is MethodParamValidator.MethodParamValidationResult));
            }
        }

        [Fact]
        public void MethodParamValidator_Should_Validate_Optional_Params()
        {
            const string source = @"
using System;
public class Test { 
    public void OptionalTest(int optional = 1, int optional2 = 2){}
}";

            var typeDefinition = CompileToTypeDef(source);

            var method = typeDefinition.Methods.First(m => m.Name == "OptionalTest");

            var result = new MethodParamValidator().Validate(method).ToList();
            Assert.Equal(2, result.Count);
            Assert.True(result.All(r => r is MethodParamValidator.MethodParamValidationResult));
        }

        [Fact]
        public void FinalizerValidator_Should_Validate_OverrideFinalizer()
        {
            const string source = @"public class Test { ~Test(){} }";

            var typeDefinition = CompileToTypeDef(source);

            var result = new FinalizerValidator().Validate(typeDefinition).ToList();

            Assert.Single(result);
            Assert.IsType<FinalizerValidator.FinalizerValidationResult>(result.Single());
        }

        [Fact]
        public void FinalizerValidator_Should_Validate_MethodFinalizer()
        {
            const string source = @"public class Test { void Finalize(){} }";

            var typeDefinition = CompileToTypeDef(source);

            var result = new FinalizerValidator().Validate(typeDefinition).ToList();

            Assert.Single(result);
            Assert.IsType<FinalizerValidator.FinalizerValidationResult>(result.Single());
        }

        public TypeDefinition CompileToTypeDef(string source)
        {
            var mscorlib = MetadataReference.CreateFromFile(typeof(object).Assembly.Location);
            var smartContracts = MetadataReference.CreateFromFile(typeof(Address).Assembly.Location);
            var runtime = MetadataReference.CreateFromFile(typeof(System.Runtime.AssemblyTargetedPatchBandAttribute).Assembly.Location);

            SyntaxTree syntaxTree = CSharpSyntaxTree.ParseText(source);

            CSharpCompilation compilation = CSharpCompilation.Create(
                "Test",
                new[] { syntaxTree },
                references: new[] { mscorlib, smartContracts, runtime },
                options: new CSharpCompilationOptions(
                    OutputKind.DynamicallyLinkedLibrary,
                    checkOverflow: true));

            using (var dllStream = new MemoryStream())
            {
                EmitResult emitResult = compilation.Emit(dllStream);
                if (!emitResult.Success)
                    throw new Exception("Compilation Failed");

                var assemblyBytes = dllStream.ToArray();

                var moduleDef = ModuleDefinition.ReadModule(new MemoryStream(assemblyBytes));

                return moduleDef.Types.First(t => !t.Name.Equals("<Module>"));
            }
        }
    }

    public class TestValidator : IMethodDefinitionValidator
    {
        public IEnumerable<ValidationResult> Validate(MethodDefinition method)
        {
            return new[]
            {
                new MethodDefinitionValidationResult(method.Name, "", "")
            };
        }

    }
}