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.

Sign up for GitHub

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

Jump to bottom

Triangulate Example Commands #1357

Open
wants to merge 38 commits into
base: main
Choose a base branch
from
Open

Triangulate Example Commands #1357

wants to merge 38 commits into from

Commits on Oct 10, 2024

  1. Add support for --base-branch in backward-compatibility-check command 

    Abstract out the common logic in backward-compatibility-check command
    @yogeshnikam671
    yogeshnikam671 committed Oct 10, 2024
    Configuration menu
    Copy the full SHA
    e03d75a View commit details
    Browse the repository at this point in the history

  2. Add support for --target-path argument in BackwardCompatibilityCheckC… 

    …ommand which can let us run the check on a specific folder or file in a repository
    @yogeshnikam671
    yogeshnikam671 committed Oct 10, 2024
    Configuration menu
    Copy the full SHA
    a7bfa42 View commit details
    Browse the repository at this point in the history

  3. Move the function to find referred spec files within BCC base class s… 

    …ince the logic is reusable.
    @yogeshnikam671
    yogeshnikam671 committed Oct 10, 2024
    Configuration menu
    Copy the full SHA
    8c7c110 View commit details
    Browse the repository at this point in the history

  4. Filter only the specs that have changed using targetPath in BackwardC… 

    …ompatibilityCheckCommand
    @yogeshnikam671
    yogeshnikam671 committed Oct 10, 2024
    Configuration menu
    Copy the full SHA
    3ba68cb View commit details
    Browse the repository at this point in the history

  5. Fix the logs in backwardCompatibilityCheckCommand

    @yogeshnikam671
    yogeshnikam671 committed Oct 10, 2024
    Configuration menu
    Copy the full SHA
    766f9fc View commit details
    Browse the repository at this point in the history

  6. Bring back the existing backwardCompatibilityCheck command 

    Add deprecation notice to all the b/w compatibility related commands which will be eventually removed
    @yogeshnikam671
    yogeshnikam671 committed Oct 10, 2024
    Configuration menu
    Copy the full SHA
    04c82dd View commit details
    Browse the repository at this point in the history

  7. Update the import statement for exitWithMessage in BackwardCompatibil… 

    …ityCheckCommand
    @yogeshnikam671
    yogeshnikam671 committed Oct 10, 2024
    Configuration menu
    Copy the full SHA
    827a305 View commit details
    Browse the repository at this point in the history

  8. Refactor the logging logic of changed files

    @yogeshnikam671
    yogeshnikam671 committed Oct 10, 2024
    Configuration menu
    Copy the full SHA
    5d82fd6 View commit details
    Browse the repository at this point in the history

  9. Add a shutdown hook in backward compatibility check command which wil… 

    …l bring the repository back to the original state if the command is aborted in between
    @yogeshnikam671
    yogeshnikam671 committed Oct 10, 2024
    Configuration menu
    Copy the full SHA
    6f1da35 View commit details
    Browse the repository at this point in the history

  10. Improve logging of backward compatibility report

    @yogeshnikam671
    yogeshnikam671 committed Oct 10, 2024
    Configuration menu
    Copy the full SHA
    768ac8e View commit details
    Browse the repository at this point in the history

  11. Add ability to disable and enable info logging in LogStrategy to avoi… 

    …d unnecessary logs in the backward compatibility check result logs
    @yogeshnikam671
    yogeshnikam671 committed Oct 10, 2024
    Configuration menu
    Copy the full SHA
    4a4ab17 View commit details
    Browse the repository at this point in the history

  12. Change scope getSpecsReferringTo method from internal to open to enab… 

    …le override in sub-classes of BackwardCompatibilityCheckBaseCommand
    @yogeshnikam671
    yogeshnikam671 committed Oct 10, 2024
    Configuration menu
    Copy the full SHA
    eff9834 View commit details
    Browse the repository at this point in the history

Commits on Oct 11, 2024

  1. Make exitWithMessage method append and prepend newLine to the message

    @yogeshnikam671
    yogeshnikam671 committed Oct 11, 2024
    Configuration menu
    Copy the full SHA
    67bc469 View commit details
    Browse the repository at this point in the history

  2. Rename getFileInTheBaseBranch to getFileInBranch

    @yogeshnikam671
    yogeshnikam671 committed Oct 11, 2024
    Configuration menu
    Copy the full SHA
    a90557d View commit details
    Browse the repository at this point in the history

  3. Staged files should be considered during the backward compatibility c… 

    …heck
    @yogeshnikam671
    yogeshnikam671 committed Oct 11, 2024
    Configuration menu
    Copy the full SHA
    3a560bf View commit details
    Browse the repository at this point in the history

Commits on Oct 14, 2024

  1. Update the description for the argument --target-path in backward-com… 

    …patibility-check command
    @yogeshnikam671
    yogeshnikam671 committed Oct 14, 2024
    Configuration menu
    Copy the full SHA
    37c001d View commit details
    Browse the repository at this point in the history

  2. Add tests for getFilesChangedInCurrentBranch function

    @yogeshnikam671
    yogeshnikam671 committed Oct 14, 2024
    Configuration menu
    Copy the full SHA
    0a8dd21 View commit details
    Browse the repository at this point in the history

  3. Fix the failing test around git command

    @yogeshnikam671
    yogeshnikam671 committed Oct 14, 2024
    Configuration menu
    Copy the full SHA
    9b37ba7 View commit details
    Browse the repository at this point in the history

Commits on Oct 15, 2024

  1. Create abstract class ExamplesBaseCommand. 

    - This class will be used in example generation
  and parity with other protocol impls.
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    c333ac6 View commit details
    Browse the repository at this point in the history

  2. WIP Commit, Major Refactor For Examples Parity 

    - New Abstract Classes for Examples Command.
- Common Interface for example generation.
- Moved InteractiveServer to application.
- Move example template to JunitSupport.
- Other HTML, CSS, JS Fixes.
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    221b8c6 View commit details
    Browse the repository at this point in the history

  3. Fix testRowExample method in interactive html js

    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    c1178dc View commit details
    Browse the repository at this point in the history

  4. CSS and JS alert fixes and improvements. 

    - never show validation alert when testing.
- fix main tag size and example name break.
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    dc7d1c7 View commit details
    Browse the repository at this point in the history

  5. Revamp Example Parity architecture. 

    - Use multi-level inheritance with interfaces.
- Introduced a common base command with shared
  functions and cmd line options.
- UI, UX fixes on frontend, etc.
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    c0eb051 View commit details
    Browse the repository at this point in the history

  6. Architecture Refactor and merge fixes. 

    - Use composition / delegation inplace of multi-
  inheritance.
- Update dictionary usage in example_parity.
- Fix errors caused by main merge.
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    bc4e73e View commit details
    Browse the repository at this point in the history

  7. Add tests OpenApi Examples Generate and Validate. 

    - Reuse tests from `ExamplesCommandTest` and
  `ExamplesInteractiveServerTest`.
- Fix typo in ExampleValidationResult.
- add few other tests.
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    a6200eb View commit details
    Browse the repository at this point in the history

  8. Fix logger based on verbosity on command execution 

    - Don't print dictionary in use, already printed
  by loadDictionary method.
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    eaa05af View commit details
    Browse the repository at this point in the history

  9. Minor refactor, update command descriptions 

    - update descriptions so they're similar across
  protocols / implementations.
- move `extensive` argument to ExamplesBase.kt
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    c3d2448 View commit details
    Browse the repository at this point in the history

  10. Examples Testing cleanup, minor refactorings. 

    - Use Feature.createContractTestFromExampleFile
  in example testing.
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    f567aa3 View commit details
    Browse the repository at this point in the history

  11. Implement inline examples validation. 

    - Add tests for inline examples validation.
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    2c2589f View commit details
    Browse the repository at this point in the history

  12. Refactor interactive example testing, better logs. 

    - Use Result instead of TestResult, add result
  report in-case of test Failure.
- [WIP] modifications to Feature test function
   createContractTestFromExampleFile.
- Don't use ExactValue Pattern for response.
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    807c8b6 View commit details
    Browse the repository at this point in the history

  13. Minor refactors, code cleanups, improvements. 

    - use consoleLog and consoleDebug from log package
- use restrictive access modifiers when possible.
- add consoleDebug to log package.
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    3d84087 View commit details
    Browse the repository at this point in the history

  14. Major Refactoring, moved InteractiveSever to core 

    - Code cleanup, moved thymeleaf to core
  completely, junit calls to core for html report
- Move examples Dataclasses to core.
- Remove unneeded Ktor deps from application.
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    5da5e51 View commit details
    Browse the repository at this point in the history

  15. refactor use Kotlin.Result whenever possible. 

    - Clean up code
- minor fixes
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    08a7fe9 View commit details
    Browse the repository at this point in the history

  16. make contentType available in openapi interactive. 

    - Move validation result logging into class for
  reusability.
- Other CSS and JS Fixes.
    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    9faf8a7 View commit details
    Browse the repository at this point in the history

  17. Fix bug causing example test to run twice.

    @StarKhan6368
    StarKhan6368 committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    d447758 View commit details
    Browse the repository at this point in the history

Commits on Oct 16, 2024

  1. modify logic for creating test from example file. 

    - load externalised example after parsing contract
 file to feature in OpenApiExamplesFeatureStrategy
- Add test to ensure canonicalPath is used when
  matching example File to examples in scenario.
- update test for example creation in Feature.
    @StarKhan6368
    StarKhan6368 committed Oct 16, 2024
    Configuration menu
    Copy the full SHA
    0622ab0 View commit details
    Browse the repository at this point in the history

  2. Merge branch 'main' into example_parity

    @StarKhan6368
    StarKhan6368 committed Oct 16, 2024
    Configuration menu
    Copy the full SHA
    3b229f1 View commit details
    Browse the repository at this point in the history

  3. Add tests for OpenApiExamplesInteractive. 

    - minor refactors to ExamplesInteractiveServer
    @StarKhan6368
    StarKhan6368 committed Oct 16, 2024
    Configuration menu
    Copy the full SHA
    01c1e36 View commit details
    Browse the repository at this point in the history