Skip to content

refactor (crc/machine) : Provide a dummy implementation for virtualMachine object for writing unit tests (#4407) #4423

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
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

refactor (crc/machine) : Provide a dummy implementation for virtualMachine object for writing unit tests (#4407) #4423

wants to merge 5 commits into from

Conversation

@rohanKanojia
Copy link
Contributor

Description

Fixes: Issue #4407

Relates to: Issue #4407, PR #4400

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change
  • Chore (non-breaking change which doesn't affect codebase;
    test, version modification, documentation, etc.)

Checklist

  • I have read the contributing guidelines
  • My code follows the style guidelines of this project
  • I Keep It Small and Simple: The smaller the PR is, the easier it is to review and have it merged
  • I use conventional commits in my commit messages
  • I have performed a self-review of my code
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I tested my code on specified platforms
    • Linux
    • Windows
    • MacOS

Solution/Idea

  • Add a VirtualMachine interface and make the CRC machine package client use the VirtualMachine interface instead of a concrete implementation. This way we can inject a dummy test FakeVirtualMachine implementation into client tests that can ease writing tests for this package.
    • Add some additional methods in VirtualMachine interface so that we can replace direct usage of struct fields with interface methods
      • Bundle()
      • Driver()
      • API()
      • GetHost()
  • Add a new field VirtualMachine in the client so we can avoid creating it if it's already created.
  • Introduce a new constructor method newClientWithVirtualMachine in machine client that would have an additional VirtualMachine argument, this would be kept package private so that it's used only by tests in the same package.
  • Add FakeVirtualMachine sturct in fakemachine for adding dummy implementation for VirtualMachine interface. Currently, I've only completed methods used by stop_test.go, I'll add more in small increments as I get more familiar with the project.

Proposed changes

  • Add new VirtualMachine interface and make client member functions use it instead of virtualMachine struct.
  • Add new constructor in machine client to be able to override VirtualMachine implementation from tests
  • These files have been modified to use VirtualMachine interface instead of virtualMachine struct (these changes are only related to changing use of virtualMachine struct to VirtualMachine interface:
    • pkg/crc/machine/ip.go
    • pkg/crc/machine/poweroff.go
    • pkg/crc/machine/start.go
    • pkg/crc/machine/status.go
    • pkg/crc/machine/stop.go

Testing

It's a small refactor. I've only run E2E tests locally to verify if these changes don't introduce any kind of regression.

@openshift-ci
Copy link

openshift-ci bot commented Oct 29, 2024

Hi @rohanKanojia. Thanks for your PR.

I'm waiting for a crc-org member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@rohanKanojia rohanKanojia force-pushed the pr/issue4407 branch 5 times, most recently from 0e36ad5 to 988b812 Compare November 5, 2024 11:32
cfergeau
cfergeau reviewed Nov 5, 2024
View reviewed changes
cfergeau
cfergeau reviewed Nov 6, 2024
View reviewed changes
@rohanKanojia rohanKanojia force-pushed the pr/issue4407 branch 2 times, most recently from ada0fc6 to fac1ad5 Compare November 7, 2024 05:31
@rohanKanojia rohanKanojia marked this pull request as ready for review November 7, 2024 09:04
@openshift-ci openshift-ci bot requested review from evidolob and gbraad November 7, 2024 09:04
@rohanKanojia rohanKanojia mentioned this pull request Nov 18, 2024
Closed
cfergeau
cfergeau reviewed Nov 22, 2024
View reviewed changes
pkg/crc/machine/stop_test.go Outdated
assert.NoError(t, stopErr)
assert.Equal(t, clusterState, state.Stopped)
assert.Equal(t, virtualMachine.IsStopped, true)
assert.Equal(t, virtualMachine.FakeSSHClient.LastExecutedCommand, "sudo -- sh -c 'crictl stop $(crictl ps -q)'")
Copy link
Contributor

Choose a reason for hiding this comment

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

In my opinion, the fact that crictl stop is the last command we run in the VM should be an implementation detail, it can change at any time if we refactor this code, if we add new things to the bundle which needs to be stopped, ...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for review, I'll remove this assertion.

@openshift-ci
Copy link

openshift-ci bot commented Jan 2, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign cfergeau for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

rohanKanojia and others added 4 commits April 9, 2025 19:54
@rohanKanojia
Add VirtualMachine interface to abstract out crc virtual machine inte…
16e3649 
…raction

Add a VirtualMachine interface and make the CRC `machine` package client use the VirtualMachine interface instead of a concrete implementation. This way we can inject a dummy test FakeVirtualMachine implementation into client tests that can ease writing tests for this package.
  - Add some additional methods in VirtualMachine interface so that we can replace direct usage of struct fields with interface methods
    - `Bundle()`
    - `Driver()`
    - `API()`
    - `Host()`
    - `Kill()`
@cfergeau @rohanKanojia
allow to provide fake vm implementation
7f74f5c 
Introduce a new constructor method `newClientWithVirtualMachine` in machine
client that would have an additional VirtualMachine argument, this would be
kept package private so that it's used only by tests in the same package.
@rohanKanojia
test : Add a dummy VirtualMachine implementation for use in tests
7d59964 
Add FakeVirtualMachine sturct in `fakemachine` for adding dummy
implementation for `VirtualMachine` interface. Currently, I've
only completed methods used by `stop_test.go`, I'll add more in
small increments as we implement more unit tests using this
implementation.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
@rohanKanojia
test (machine) : Add additional tests in stop_test.go to use dummy Vi…
c1e3dbe 
…rtualMachine implementation

Add additional tests in `stop_test.go` to verify that client.Stop()
updates the state of virtual machine and unexposes exposed ports
as expected. Use the fake vm implementation added previously to
test vm state modification behavior on stop.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
@rohanKanojia
test (machine) : add vsock interaction methods to VirtualMachine inte…
5b63280 
…rface

Make VirtualMachine implement vsock methods so that vsock interaction
is also done via VirtualMachine interface. This would help in writing
tests, we can override the behavior of expose/unexpose in fake vm
implementation.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cfergeau cfergeau cfergeau left review comments

@evidolob evidolob Awaiting requested review from evidolob

@gbraad gbraad Awaiting requested review from gbraad

Assignees

No one assigned

Labels

needs-ok-to-test

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rohanKanojia @cfergeau