1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
|
package agent
import (
"bytes"
"context"
"encoding/json"
"io"
"net/http"
"testing"
"time"
"github.com/golang/mock/gomock"
"github.com/stretchr/testify/suite"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/modagent"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/module/remote_development/agent/k8s"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/retry"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/testing/mock_modagent"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/testing/testhelpers"
"go.uber.org/zap/zaptest"
)
type ReconcilerTestSuite struct {
suite.Suite
runner reconciler
mockApi *mock_modagent.MockApi
mockInformer *mockInformer
mockK8sClient *k8s.MockClient
}
func TestRemoteDevModuleReconciler(t *testing.T) {
suite.Run(t, new(ReconcilerTestSuite))
}
func (r *ReconcilerTestSuite) TestSuccessfulTerminationOfWorkspace() {
ctx, cancel := context.WithTimeout(context.Background(), time.Second*3)
defer cancel()
existingWorkspaceA := r.newMockWorkspaceInAgent("workspaceA")
r.mockInformer.Resources = map[string]*parsedWorkspace{
existingWorkspaceA.Name: existingWorkspaceA,
}
// test assumes an existing running workspace that rails intends to terminate
r.ensureWorkspaceExists(ctx, r.runner.stateTracker, r.mockK8sClient, existingWorkspaceA)
workspaceChangesFromRails := r.generateInfoForWorkspaceChanges(existingWorkspaceA.Name, WorkspaceStateTerminated, "Running")
r.expectRequestAndReturnReply(r.mockApi, r.generateRailsRequest(WorkspaceUpdateTypeFull), r.generateRailsResponse(workspaceChangesFromRails))
err := r.runner.Run(ctx)
r.Require().NoError(err)
r.Require().True(r.runner.terminatingTracker.isTerminating(existingWorkspaceA.Name, existingWorkspaceA.Namespace))
r.Require().Contains(r.runner.stateTracker.persistedVersion, existingWorkspaceA.Name)
// simulate "Terminating" state for workspace i.e. create workspace if it doesn't already exist
r.ensureWorkspaceExists(ctx, r.runner.stateTracker, r.mockK8sClient, existingWorkspaceA)
// In the next partial sync, and until the workspace is removed from the cluster, agentk will keep sending workspace
// info with termination progress as Terminating
workspaceChangesFromRails = r.generateInfoForWorkspaceChanges(existingWorkspaceA.Name, WorkspaceStateTerminated, "Terminating")
r.expectRequestAndReturnReply(
r.mockApi,
r.generateRailsRequest(WorkspaceUpdateTypePartial, r.agentInfoWithTerminationProgress(existingWorkspaceA, TerminationProgressTerminating)),
r.generateRailsResponse(workspaceChangesFromRails),
)
err = r.runner.Run(ctx)
r.Require().NoError(err)
r.Require().True(r.runner.terminatingTracker.isTerminating(existingWorkspaceA.Name, existingWorkspaceA.Namespace))
r.Require().Contains(r.runner.stateTracker.persistedVersion, existingWorkspaceA.Name)
// In this cycle, agent will discover that the workspace has been deleted which will result in the workspace being
// removed from all the trackers after a successful exchange with rails
delete(r.mockInformer.Resources, existingWorkspaceA.Name)
workspaceChangesFromRails = r.generateInfoForWorkspaceChanges(existingWorkspaceA.Name, WorkspaceStateTerminated, WorkspaceStateTerminated)
r.expectRequestAndReturnReply(
r.mockApi,
r.generateRailsRequest(WorkspaceUpdateTypePartial, r.agentInfoWithTerminationProgress(existingWorkspaceA, TerminationProgressTerminated)),
r.generateRailsResponse(workspaceChangesFromRails),
)
err = r.runner.Run(ctx)
r.Require().NoError(err)
r.Require().False(r.runner.terminatingTracker.isTerminating(existingWorkspaceA.Name, existingWorkspaceA.Namespace))
r.Require().NotContains(r.runner.stateTracker.persistedVersion, existingWorkspaceA.Name)
// In the next cycle, no more information for the terminated workspace will be shared with rails as there
// no information about this workspace either in agent's internal state nor in the cluster
r.expectRequestAndReturnReply(r.mockApi, r.generateRailsRequest(WorkspaceUpdateTypePartial), r.generateRailsResponse())
err = r.runner.Run(ctx)
r.Require().NoError(err)
r.Require().False(r.runner.terminatingTracker.isTerminating(existingWorkspaceA.Name, existingWorkspaceA.Namespace))
r.Require().NotContains(r.runner.stateTracker.persistedVersion, existingWorkspaceA.Name)
r.Require().False(r.mockK8sClient.NamespaceExists(ctx, existingWorkspaceA.Namespace))
}
func (r *ReconcilerTestSuite) TestSuccessfulCreationOfWorkspace() {
ctx, cancel := context.WithTimeout(context.Background(), time.Second*3)
defer cancel()
workspace := "workspaceA"
currentWorkspaceState := r.newMockWorkspaceInAgent(workspace)
// step1: expect nothing in rails req, get creation req in rails resp => expect changes to be applied
r.expectRequestAndReturnReply(r.mockApi, r.generateRailsRequest(WorkspaceUpdateTypeFull), r.generateRailsResponse(r.generateInfoForNewWorkspace(workspace)))
err := r.runner.Run(ctx)
r.Require().NoError(err)
r.Require().False(r.runner.terminatingTracker.isTerminating(currentWorkspaceState.Name, currentWorkspaceState.Namespace))
r.Require().Contains(r.runner.stateTracker.persistedVersion, workspace)
// step2: simulate transition to "Starting" step (modify resource version in informer), expect rails req to contain update
r.updateMockWorkspaceStateInInformer(r.mockInformer, currentWorkspaceState)
//ensure rails acks the latest persisted version
workspaceChangesFromRails := r.generateInfoForWorkspaceChanges(workspace, "Running", "Starting")
workspaceChangesFromRails.DeploymentResourceVersion = currentWorkspaceState.ResourceVersion
r.expectRequestAndReturnReply(
r.mockApi,
r.generateRailsRequest(WorkspaceUpdateTypePartial, r.agentInfoForNonTerminatedWorkspace(currentWorkspaceState)),
r.generateRailsResponse(workspaceChangesFromRails),
)
err = r.runner.Run(ctx)
r.Require().NoError(err)
r.Require().False(r.runner.terminatingTracker.isTerminating(currentWorkspaceState.Name, currentWorkspaceState.Namespace))
r.Require().Contains(r.runner.stateTracker.persistedVersion, workspace)
// step3: simulate transition to "Running" step(modify resource version in informer), expect rails req to contain update
r.updateMockWorkspaceStateInInformer(r.mockInformer, currentWorkspaceState)
workspaceChangesFromRails = r.generateInfoForWorkspaceChanges(workspace, "Running", "Running")
workspaceChangesFromRails.DeploymentResourceVersion = currentWorkspaceState.ResourceVersion
r.expectRequestAndReturnReply(
r.mockApi,
r.generateRailsRequest(WorkspaceUpdateTypePartial, r.agentInfoForNonTerminatedWorkspace(currentWorkspaceState)),
r.generateRailsResponse(workspaceChangesFromRails),
)
err = r.runner.Run(ctx)
r.Require().NoError(err)
r.Require().False(r.runner.terminatingTracker.isTerminating(currentWorkspaceState.Name, currentWorkspaceState.Namespace))
r.Require().Contains(r.runner.stateTracker.persistedVersion, workspace)
// step4: nothing changes in resource, expect rails req to not contain workspace metadata, expect metadata to be present in tracker (but not in terminated tracker)
r.expectRequestAndReturnReply(r.mockApi, r.generateRailsRequest(WorkspaceUpdateTypePartial), r.generateRailsResponse())
err = r.runner.Run(ctx)
r.Require().NoError(err)
r.Require().False(r.runner.terminatingTracker.isTerminating(currentWorkspaceState.Name, currentWorkspaceState.Namespace))
r.Require().Contains(r.runner.stateTracker.persistedVersion, workspace)
}
func (r *ReconcilerTestSuite) updateMockWorkspaceStateInInformer(mockInformer *mockInformer, workspace *parsedWorkspace) {
workspace.ResourceVersion = workspace.ResourceVersion + "1"
mockInformer.Resources[workspace.Name] = workspace
}
func (r *ReconcilerTestSuite) ensureWorkspaceExists(ctx context.Context, stateTracker *persistedStateTracker, mockK8sClient *k8s.MockClient, existingWorkspaceA *parsedWorkspace) {
if _, ok := stateTracker.persistedVersion[existingWorkspaceA.Name]; !ok {
stateTracker.recordVersion(&WorkspaceRailsInfo{
Name: existingWorkspaceA.Name,
Namespace: existingWorkspaceA.Namespace,
DeploymentResourceVersion: existingWorkspaceA.ResourceVersion,
})
}
if !mockK8sClient.NamespaceExists(ctx, existingWorkspaceA.Namespace) {
_ = mockK8sClient.CreateNamespace(ctx, existingWorkspaceA.Namespace)
}
}
func (r *ReconcilerTestSuite) generateRailsResponse(infos ...*WorkspaceRailsInfo) ResponsePayload {
return ResponsePayload{WorkspaceRailsInfos: infos}
}
func (r *ReconcilerTestSuite) expectRequestAndReturnReply(mockApi *mock_modagent.MockApi, expectedRequest RequestPayload, response ResponsePayload) {
extractRequestPayload := func(dataReader io.ReadCloser) RequestPayload {
var request RequestPayload
raw, err := io.ReadAll(dataReader)
r.Require().NoError(err)
err = json.Unmarshal(raw, &request)
r.Require().NoError(err)
return request
}
mockApi.EXPECT().
MakeGitLabRequest(gomock.Any(), "/reconcile", gomock.Any()).Times(1).
DoAndReturn(func(ctx context.Context, path string, opts ...modagent.GitLabRequestOption) (*modagent.GitLabResponse, error) {
requestConfig, err := modagent.ApplyRequestOptions(opts)
r.Require().NoError(err)
requestBody := extractRequestPayload(requestConfig.Body)
r.Require().Equal(expectedRequest, requestBody)
var body []byte
body, err = json.Marshal(response)
r.Require().NoError(err)
return &modagent.GitLabResponse{
StatusCode: http.StatusCreated,
Body: io.NopCloser(bytes.NewReader(body)),
}, nil
})
}
func (r *ReconcilerTestSuite) generateInfoForNewWorkspace(name string) *WorkspaceRailsInfo {
return &WorkspaceRailsInfo{
Name: name,
Namespace: name + "-namespace",
DeploymentResourceVersion: "",
ActualState: "Creating",
DesiredState: "Running",
ConfigToApply: "",
}
}
func (r *ReconcilerTestSuite) generateInfoForWorkspaceChanges(name, desiredState, actualState string) *WorkspaceRailsInfo {
return &WorkspaceRailsInfo{
Name: name,
Namespace: name + "-namespace",
DeploymentResourceVersion: "1",
ActualState: actualState,
DesiredState: desiredState,
ConfigToApply: "test",
}
}
func (r *ReconcilerTestSuite) generateRailsRequest(updateType WorkspaceUpdateType, agentInfos ...WorkspaceAgentInfo) RequestPayload {
// agentInfos may be a nil slice. However, we want it to be an empty(0-length) slice. Hence, the explicit initialization.
if len(agentInfos) == 0 {
agentInfos = make([]WorkspaceAgentInfo, 0)
}
return RequestPayload{
UpdateType: updateType,
WorkspaceAgentInfos: agentInfos,
}
}
func (r *ReconcilerTestSuite) agentInfoForNonTerminatedWorkspace(workspace *parsedWorkspace) WorkspaceAgentInfo {
return WorkspaceAgentInfo{
Name: workspace.Name,
Namespace: workspace.Namespace,
}
}
func (r *ReconcilerTestSuite) agentInfoWithTerminationProgress(workspace *parsedWorkspace, progress TerminationProgress) WorkspaceAgentInfo {
return WorkspaceAgentInfo{
Name: workspace.Name,
Namespace: workspace.Namespace,
TerminationProgress: progress,
}
}
func (r *ReconcilerTestSuite) newMockWorkspaceInAgent(name string) *parsedWorkspace {
return &parsedWorkspace{
Name: name,
Namespace: name + "-namespace",
ResourceVersion: "1",
K8sDeploymentInfo: nil,
}
}
func (r *ReconcilerTestSuite) SetupTest() {
ctrl := gomock.NewController(r.T())
r.mockApi = mock_modagent.NewMockApi(ctrl)
r.mockK8sClient = k8s.NewMockClient()
r.mockInformer = newMockInformer()
// this should ideally be called once per run
// however, since each test may have multiple runs, this is just put here for simplicity
r.mockApi.EXPECT().GetAgentId(gomock.Any()).AnyTimes()
r.runner = reconciler{
log: zaptest.NewLogger(r.T()),
agentId: testhelpers.AgentId,
api: r.mockApi,
pollConfig: testhelpers.NewPollConfig(time.Second),
pollFunction: func(ctx context.Context, cfg retry.PollConfig, f retry.PollWithBackoffCtxFunc) error {
err, _ := f(ctx)
return err
},
stateTracker: newPersistedStateTracker(),
terminatingTracker: newPersistedTerminatingWorkspacesTracker(),
informer: r.mockInformer,
k8sClient: r.mockK8sClient,
}
}
|