Skip to content

Conversation

@Demian-Yushyn
Copy link
Contributor

Motivation

SwiftMocky has been unmaintained for ~3 years and is no longer compatible with modern Xcode / Swift toolchains.
In recent Xcode versions, this caused test builds to be unstable or completely broken, increasing maintenance cost and blocking further modernization of the project.

To address this, this PR removes SwiftMocky and migrates the project to Mockolo, a lightweight, actively maintained mock generator that integrates well with modern Swift and modular architectures.

What was done

  • Removed SwiftMocky
  • Deleted SwiftMocky dependency from test targets
  • Removed generated mocks and related configuration
  • Introduced Mockolo
  • Migrated mock generation to Mockolo
  • Uses source annotations instead of runtime code generation
  • Mock generation workflow
    Protocols intended for mocking are annotated with:
/// @mockable
public protocol ConfigProtocol: Sendable { ... }
  • Mocks are generated by running:
./generateMockoloMocks.sh
  • Generated mocks are placed under Generated/ folders per module, for example:
Core/CoreTests/Generated/CoreMocks.generated.swift
Course/CourseTests/Generated/CourseMocks.generated.swift
  • Updated tests
  • Refactored existing tests to use Mockolo-generated mocks
  • No behavior changes in production code
  • Test logic and coverage remain functionally equivalent

Tooling note

Mockolo is not added to the project as a dependency (SPM / CocoaPods / Carthage).
It is used as an external code generation tool and is expected to be installed locally via Homebrew:

brew install mockolo

This keeps the project dependency graph clean and avoids introducing build-time dependencies into app or test targets.

Why Mockolo

  • Actively maintained
  • Compatible with modern Swift and Xcode versions
  • Simple, annotation-based approach
  • No runtime dependencies or reflection
  • Well-suited for multi-module projects

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 29, 2026
@openedx-webhooks
Copy link

Thanks for the pull request, @Demian-Yushyn!

This repository is currently maintained by @openedx/openedx-mobile-maintainers.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Copy link
Contributor

@IvanStepanok IvanStepanok left a comment

Choose a reason for hiding this comment

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

Huge and important work! Looks great!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

3 participants