fix: coderdtest: increase ForceCancelInterval #3085
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Two unit tests (TestPatchCancelTemplateVersion/Success and Test- PatchCancelWorkspaceBuild) implied errneously that the job was canceled successfully. This is not the case, as these unit tests do not include a Provision_Complete response in the input to the echo provisioner. Now explicitly checking the job error.
mafredri
approved these changes
Jul 21, 2022
There was a problem hiding this comment.
As far as workarounds go, this looks OK to me. I'd like to defer to @spikecurtis for a correctness check though.
| @@ -150,8 +150,11 @@ func TestPatchCancelTemplateVersion(t *testing.T) { | |||
| require.Eventually(t, func() bool { | |||
| var err error | |||
| version, err = client.TemplateVersion(context.Background(), version.ID) | |||
| require.NoError(t, err) | |||
| return version.Job.Status == codersdk.ProvisionerJobCanceled | |||
| return assert.NoError(t, err) && | |||
There was a problem hiding this comment.
Oh nice, TIL these could be used as booleans.
Kira-Pilot
approved these changes
Jul 21, 2022
spikecurtis
approved these changes
Jul 21, 2022
| // The job will never actually cancel successfully because it will never send a | ||
| // provision complete response. | ||
| assert.Empty(t, version.Job.Error) && | ||
| version.Job.Status == codersdk.ProvisionerJobCanceling |
There was a problem hiding this comment.
This is fine with me as a workaround for now, but it exposes that we don't have any tests that actually reach JobCanceled. For that we need to either enhance the echo provisioner, or make a new provisioner that just waits until it is canceled and returns a successful cancel.
One thing that's probably worth doing is renaming this testcase Success -> Canceling to reflect the fact that we don't have a Success testcase yet.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Two
coderdunit tests (TestPatchCancelTemplateVersion/SuccessandTestPatchCancelWorkspaceBuild) implied erroneously that the job was canceled successfully.This is not the case, as these unit tests do not include a Provision_Complete response in the input to the
echo provisioner. Now explicitly checking the job error and bumping the force cancel interval to be longer.
I'm not sure if this is the "correct" fix here; I'm mainly unblocking #3061.
It seems that the "right" way would be to allow some way of modifying the contents of the test provisioner's job in-flight.
For example in this use-case, we want to have the job initially returning only logs (implying in progress), and then also returning a complete after we cancel.
There's another use case where we want the status quo, e.g. to test the force cancelation logic.
Fixes #3083.