📄 core/tests/CallGraphBuilderTests/FindCallersShould.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
using System.Threading.Tasks;
using Microsoft.CodeAnalysis;
using Shouldly;
using Xunit;

namespace Cfa.Tests.CallGraphBuilderTests;

public sealed class FindCallersShould
{
    [Theory]
    [InlineData("Updated message")]
    [InlineData("Sample.Domain.Message<int> message")]
    public async Task UseTheConcreteArgumentTypeWhenLookingUpPublishers(string parameter)
    {
        // Arrange
        var source =
            MessageSource.Contracts
            + $$"""
                class Example : Sample.Grains.EventHandlers.EventReceiver<Sample.Domain.Message<int>>
                {
                    public Example() { On<Updated>(Start); }
                    void Start(Updated evt) { }
                }
                class Sender
                {
                    void Publish(Sample.GrainInterfaces.Events.IEventSender sender, {{parameter}})
                    {
                        sender.Publish(message);
                    }
                    void Unrelated(Sample.GrainInterfaces.Events.IEventSender sender) { sender.Publish(new Other()); }
                }
                """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        if (parameter == "Updated message")
        {
            var publisher = callers[start].ShouldHaveSingleItem();
            publisher.Target.Name.ShouldBe("Publish");
            publisher.LinkKind.ShouldBe(LinkKind.Event);
        }
        else
        {
            callers[start].ShouldBeEmpty();
        }
    }

    [Theory]
    [InlineData("On<Updated>(Start);")]
    [InlineData("On<Updated>(evt => Start(evt));")]
    public async Task FindEventPublishersFromTheReceivingMethod(string registration)
    {
        // Arrange
        var source =
            MessageSource.Contracts
            + $$"""
                class Example : Sample.Grains.EventHandlers.EventReceiver<Sample.Domain.Message<int>>
                {
                    public Example() { {{registration}} }
                    void Start(Updated evt) { }
                }
                class Sender
                {
                    void Publish(Sample.GrainInterfaces.Events.IEventSender publisher) { publisher.Publish(new Updated()); }
                }
                """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        var caller = callers[start].ShouldHaveSingleItem();
        if (registration.Contains("=>"))
        {
            caller.LinkKind.ShouldBe(LinkKind.Direct);
            caller = callers[caller.Target].ShouldHaveSingleItem();
        }
        caller.Target.Name.ShouldBe("Publish");
        caller.LinkKind.ShouldBe(LinkKind.Event);
    }

    [Fact]
    public async Task FindCommandPublishersFromTheReceivingMethod()
    {
        // Arrange
        var source =
            MessageSource.Contracts
            + """
                class Example : Sample.Grains.CommandReceiver<object, int, object>
                {
                    public Example() { When<Change>(Start); }
                    void Start(Change command, object aggregate) { }
                }
                class Sender
                {
                    void Send(Sample.GrainInterfaces.Commands.ICommandSender bus) { bus.Dispatch(new Change()); }
                }
                """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        var caller = callers[start].ShouldHaveSingleItem();
        caller.Target.Name.ShouldBe("Send");
        caller.LinkKind.ShouldBe(LinkKind.Event);
    }

    [Theory]
    [InlineData("_ = Start;", "int Start { get => 1; set { } }")]
    [InlineData("Start = 2;", "int Start { get => 1; set { } }")]
    public async Task FindPropertyAccesses(string access, string declaration)
    {
        // Arrange
        var source = $$"""
            class Example
            {
                {{declaration}}
                void Caller() { {{access}} }
            }
            """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        var caller = callers[start].ShouldHaveSingleItem();
        caller.Target.Name.ShouldBe("Caller");
        caller.LinkKind.ShouldBe(LinkKind.Direct);
    }

    [Theory]
    [InlineData("_ = this[0];", "int this[int index] => Start(index);")]
    [InlineData("this[0] = 1;", "int this[int index] { get => index; set => Start(index + value); }")]
    public async Task FindIndexer(string access, string declaration)
    {
        // Arrange
        var source = $$"""
            class Example
            {
                int Start(int index) => 1;
                {{declaration}}
                void Caller() { {{access}} }
            }
            """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        var indexer = callers[start].ShouldHaveSingleItem();
        var caller = callers[indexer.Target].ShouldHaveSingleItem();
        caller.Target.Name.ShouldBe("Caller");
        caller.LinkKind.ShouldBe(LinkKind.Direct);
    }

    [Theory]
    [InlineData("get { return Start(); }")]
    [InlineData("get => Start();")]
    [InlineData("set { Start(); }")]
    public async Task AttributeAccessorCallsToTheirProperty(string accessor)
    {
        // Arrange
        var source = $$"""
            class Example
            {
                int Value { {{accessor}} }
                int Start() => 1;
            }
            """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        callers[start].ShouldHaveSingleItem().Target.Name.ShouldBe("Value");
    }

    [Theory]
    [InlineData("new Example()")]
    [InlineData("new()")]
    public async Task FindConstructorCalls(string creation)
    {
        // Arrange
        var source = $$"""
            class Example
            {
                public Example() { Start(); }
                void Start() { }
                static void Caller() { Example example = {{creation}}; }
            }
            """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        var constructor = callers[start].ShouldHaveSingleItem().Target;
        constructor.ShouldBeAssignableTo<IMethodSymbol>().MethodKind.ShouldBe(MethodKind.Constructor);
        callers[constructor].ShouldHaveSingleItem().Target.Name.ShouldBe("Caller");
    }

    [Fact]
    public async Task FindCallsThroughMetadataInterfaces()
    {
        // Arrange
        const string source = """
            class Example : System.IDisposable
            {
                public void Dispose() { Start(); }
                void Start() { }
                void Caller(System.IDisposable service) { service.Dispose(); }
            }
            """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        var dispose = callers[start].ShouldHaveSingleItem().Target;
        var caller = callers[dispose].ShouldHaveSingleItem();
        caller.Target.Name.ShouldBe("Caller");
        caller.LinkKind.ShouldBe(LinkKind.Abstract);
    }

    [Fact]
    public async Task IgnoreDirectCallsToOtherImplementations()
    {
        // Arrange
        const string source = """
            interface IService { void Run(); }
            class Other : IService { public void Run() { } }
            class Example : IService
            {
                public void Run() { Start(); }
                void Start() { }
                void Caller(Other other) { other.Run(); }
            }
            """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        var run = callers[start].ShouldHaveSingleItem().Target;
        callers[run].ShouldBeEmpty();
    }

    [Fact]
    public async Task DeduplicateCallersAndStopAtCycles()
    {
        // Arrange
        const string source = """
            class Example
            {
                void Start() { Caller(); }
                void Caller() { Start(); Start(); }
            }
            """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        var caller = callers[start].ShouldHaveSingleItem().Target;
        callers[caller].ShouldHaveSingleItem().Target.ShouldBe(start);
        callers.Count.ShouldBe(2);
    }

    [Fact]
    public async Task FindCallsThroughVirtualBaseMembers()
    {
        // Arrange
        const string source = """
            class Base { public virtual void Run() { } }
            class Example : Base
            {
                public override void Run() { Start(); }
                void Start() { }
                void Caller(Base service) { service.Run(); }
            }
            """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        var run = callers[start].ShouldHaveSingleItem().Target;
        var caller = callers[run].ShouldHaveSingleItem();
        caller.Target.Name.ShouldBe("Caller");
        caller.LinkKind.ShouldBe(LinkKind.Abstract);
    }

    [Fact]
    public async Task FindCallsInsideLambdas()
    {
        // Arrange
        const string source = """
            class Example
            {
                void Start() { }
                void Caller() { System.Action action = () => Start(); action(); }
            }
            """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        callers[start].ShouldHaveSingleItem().Target.Name.ShouldBe("Caller");
    }

    [Fact]
    public async Task ReturnAnEmptyListWhenThereAreNoCallers()
    {
        // Arrange
        const string source = """
            class Example { void Start() { } }
            """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        callers[start].ShouldBeEmpty();
    }

    [Fact]
    public async Task FollowCallers()
    {
        // Arrange
        var source = """
            class Example
            {
                void TwoUp() { OneUp(); }
                void OneUp() { Start(); }
                void Start() { }
            }
            """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        var oneUp = callers[start].ShouldHaveSingleItem().Target;
        oneUp.Name.ShouldBe("OneUp");
        var twoUp = callers[oneUp].ShouldHaveSingleItem().Target;
        twoUp.Name.ShouldBe("TwoUp");
    }

    [Fact]
    public async Task FindExpressionBodiedProperties()
    {
        // Arrange
        var source = """
            class Example
            {
                int Value => Start();
                int Start() => 42;
            }
            """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        callers[start].ShouldHaveSingleItem().Target.Name.ShouldBe("Value");
    }

    [Fact]
    public async Task FindCallsToTheAbstractMethodThatTheOriginImplements()
    {
        // Arrange
        var source = """
            abstract class Base
            {
                public abstract void Run();
            }
            class Example : Base
            {
                void ShouldBeFound(Base b) { b.Run(); }
                public override void Run() { Start(); }
                void Start() { }
            }
            """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        var concreteRun = callers[start].ShouldHaveSingleItem();
        concreteRun.Target.ContainingType.Name.ShouldBe("Example");
        var shouldBeFound = callers[concreteRun.Target].ShouldHaveSingleItem();
        shouldBeFound.Target.Name.ShouldBe("ShouldBeFound");
        shouldBeFound.LinkKind.ShouldBe(LinkKind.Abstract);
    }

    [Theory]
    [InlineData("service.Run(); Run();")]
    [InlineData("Run(); service.Run();")]
    public async Task PreferDirectCallsOverInterfaceLinks(string body)
    {
        // Arrange
        var source = $$"""
            interface IService { void Run(); }
            class Example : IService
            {
                void ShouldBeFound(IService service) { {{body}} }
                public void Run() { Start(); }
                void Start() { }
            }
            """;

        // Act
        var (start, callers) = await source.FindCallers();

        // Assert
        var concreteRun = callers[start].ShouldHaveSingleItem();
        concreteRun.Target.ContainingType.Name.ShouldBe("Example");
        var shouldBeFound = callers[concreteRun.Target].ShouldHaveSingleItem();
        shouldBeFound.Target.Name.ShouldBe("ShouldBeFound");
        shouldBeFound.LinkKind.ShouldBe(LinkKind.Direct);
    }
}