Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify mocking IO in PackageManager, add a test for add-path #2881

Merged
merged 8 commits into from Feb 26, 2024

Conversation

Geod24
Copy link
Member

@Geod24 Geod24 commented Feb 24, 2024

@s-ludwig : I would like to remove the scanning behavior in PackageManager. This is a source of pain for us, as it slows down builds, including with @atilaneves Reggae.

Last time that introduced a regression which you fixed in #2481 .
This simplifies mocking quite a bit and introduces a test for it (see last commit / source/dub/test/other.d in the diff).
If you could have a quick look at the test and confirm that it covers your use case ?

@Geod24 Geod24 requested a review from s-ludwig February 24, 2024 13:53
Copy link

github-actions bot commented Feb 24, 2024

✅ PR OK, no changes in deprecations or warnings

Total deprecations: 0

Total warnings: 0

Build statistics:

 statistics (-before, +after)
 executable size=5356064 bin/dub
-rough build time=63s
+rough build time=62s
Full build output
DUB version 1.35.1, built on Jan  6 2024
LDC - the LLVM D compiler (1.36.0):
  based on DMD v2.106.1 and LLVM 17.0.6
  built with LDC - the LLVM D compiler (1.36.0)
  Default target: x86_64-unknown-linux-gnu
  Host CPU: znver3
  http://dlang.org - http://wiki.dlang.org/LDC


  Registered Targets:
    aarch64     - AArch64 (little endian)
    aarch64_32  - AArch64 (little endian ILP32)
    aarch64_be  - AArch64 (big endian)
    amdgcn      - AMD GCN GPUs
    arm         - ARM
    arm64       - ARM64 (little endian)
    arm64_32    - ARM64 (little endian ILP32)
    armeb       - ARM (big endian)
    avr         - Atmel AVR Microcontroller
    bpf         - BPF (host endian)
    bpfeb       - BPF (big endian)
    bpfel       - BPF (little endian)
    hexagon     - Hexagon
    lanai       - Lanai
    loongarch32 - 32-bit LoongArch
    loongarch64 - 64-bit LoongArch
    mips        - MIPS (32-bit big endian)
    mips64      - MIPS (64-bit big endian)
    mips64el    - MIPS (64-bit little endian)
    mipsel      - MIPS (32-bit little endian)
    msp430      - MSP430 [experimental]
    nvptx       - NVIDIA PTX 32-bit
    nvptx64     - NVIDIA PTX 64-bit
    ppc32       - PowerPC 32
    ppc32le     - PowerPC 32 LE
    ppc64       - PowerPC 64
    ppc64le     - PowerPC 64 LE
    r600        - AMD GPUs HD2XXX-HD6XXX
    riscv32     - 32-bit RISC-V
    riscv64     - 64-bit RISC-V
    sparc       - Sparc
    sparcel     - Sparc LE
    sparcv9     - Sparc V9
    spirv32     - SPIR-V 32-bit
    spirv64     - SPIR-V 64-bit
    systemz     - SystemZ
    thumb       - Thumb
    thumbeb     - Thumb (big endian)
    ve          - VE
    wasm32      - WebAssembly 32-bit
    wasm64      - WebAssembly 64-bit
    x86         - 32-bit X86: Pentium-Pro and above
    x86-64      - 64-bit X86: EM64T and AMD64
    xcore       - XCore
   Upgrading project in /home/runner/work/dub/dub/
    Starting Performing "release" build using /opt/hostedtoolcache/dc/ldc2-1.36.0/x64/ldc2-1.36.0-linux-x86_64/bin/ldc2 for x86_64.
    Building dub 1.36.0+commit.130.gbb87c8bf: building configuration [application]
     Linking dub
STAT:statistics (-before, +after)
STAT:executable size=5356064 bin/dub
STAT:rough build time=62s

Moving it to PackageManager allows us to call PackageManager.existsFile,
allowing us to mock a lot more things.
This allows us to test the behavior of the base class much better,
by overriding the last IO function, readText.
This is one more step towards removing our mocking of refresh_.
We can finally test the full features of the base function,
as we are now mocking the IO, not the logic.
Mocking IO is required for writeLocalPackageList,
as we want to test the 'add-path' behavior.
While it is not a big concern for overrides, as they
are deprecated and we are unlikely to add new tests,
it is easy to do, and already done for reading them.
This will prove handy when writting tests that require multiple
invocation of Dub, such as idempotence tests, or things like
add-path which currently don't propagate their change through
Dub as they are one shot commands.
So that tests can use 'NativePath' and 'toNativeString'.
This was not currently tested explicitly, and is currently
the reason why we still have the scanning behavior in the
PackageManager.
In order to remove the scanning behavior and have the PM
lazily scan packages, we first must add test to ensure
there will be no further regression.
@Geod24
Copy link
Member Author

Geod24 commented Feb 25, 2024

This has quite a lot of improvements I need to fix other bugs (write more tests), so I'm going to merge it in ~10 hours unless anyone objects.

@thewilsonator thewilsonator merged commit 1acfe7b into dlang:master Feb 26, 2024
31 checks passed
@Geod24 Geod24 deleted the mlang/Test2481 branch February 27, 2024 16:27
Copy link
Member

@PetarKirov PetarKirov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reviewed the commits one-by-one and everything looks moving in the right direction. Awesome work @Geod24 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants