Skip to content

Commit c19f200

Browse files
authored
Retry REST SVM lookup with MetroCluster alternate name
1 parent 5a28c5a commit c19f200

5 files changed

Lines changed: 118 additions & 1 deletion

File tree

‎storage_drivers/ontap/api/api_common.go‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,20 @@ package api
44

55
import "strings"
66

7-
const policyDRVariantSuffix = "-DR"
7+
const (
8+
policyDRVariantSuffix = "-DR"
9+
svmMCCVariantSuffix = "-mc"
10+
)
11+
12+
// mccAlternateSVMName returns the MetroCluster counterpart of an SVM name. After a switchover
13+
// the SVM keeps its UUID but is served by the partner cluster as "<name>-mc", and switchback
14+
// reverses that, so a name saved before either event no longer matches.
15+
func mccAlternateSVMName(svm string) string {
16+
if strings.HasSuffix(svm, svmMCCVariantSuffix) {
17+
return strings.TrimSuffix(svm, svmMCCVariantSuffix)
18+
}
19+
return svm + svmMCCVariantSuffix
20+
}
821

922
// expandPolicyForVolumeListQuery returns a policy filter that matches both the configured
1023
// value and its MetroCluster / SVM-DR counterpart. ONTAP may rename policies on the DR site

‎storage_drivers/ontap/api/api_common_test.go‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,21 @@ func TestExpandPolicyForVolumeListQuery(t *testing.T) {
5252
})
5353
}
5454
}
55+
56+
func TestMccAlternateSVMName(t *testing.T) {
57+
tests := []struct {
58+
name string
59+
svm string
60+
want string
61+
}{
62+
{name: "source name gets mc suffix", svm: "vs1", want: "vs1-mc"},
63+
{name: "mc suffix is removed", svm: "vs1-mc", want: "vs1"},
64+
{name: "mc only in middle is not treated as suffix", svm: "vs-mc-1", want: "vs-mc-1-mc"},
65+
}
66+
67+
for _, tt := range tests {
68+
t.Run(tt.name, func(t *testing.T) {
69+
assert.Equal(t, tt.want, mccAlternateSVMName(tt.svm))
70+
})
71+
}
72+
}

‎storage_drivers/ontap/api/ontap_rest.go‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,9 +314,25 @@ func EnsureSVMWithRest(
314314
if ontapConfig.SVM != "" {
315315
// Attempt to use the specified SVM
316316
vserver, err := restClient.SvmGetByName(ctx, ontapConfig.SVM)
317+
if errors.IsNotFoundError(err) {
318+
// The SVM may have changed sides in a MetroCluster, so retry with the MCC alternate name.
319+
alternateSVM := mccAlternateSVMName(ontapConfig.SVM)
320+
Logc(ctx).WithFields(LogFields{
321+
"SVM": ontapConfig.SVM,
322+
"alternateSVM": alternateSVM,
323+
}).Debug("SVM not found, retrying with MetroCluster alternate name.")
324+
vserver, err = restClient.SvmGetByName(ctx, alternateSVM)
325+
}
317326
if err != nil {
318327
return fmt.Errorf("unable to get details for SVM %v; %v", ontapConfig.SVM, err)
319328
}
329+
if vserver == nil {
330+
return fmt.Errorf("unable to get details for SVM %v; no SVM returned", ontapConfig.SVM)
331+
}
332+
if vserver.Name != nil {
333+
ontapConfig.SVM = *vserver.Name
334+
restClient.SetSVMName(*vserver.Name)
335+
}
320336
if vserver.UUID != nil {
321337
restClient.SetSVMUUID(*vserver.UUID)
322338
}
@@ -4821,6 +4837,9 @@ func (c *RestClient) SvmGetByName(ctx context.Context, svmName string) (*models.
48214837
if result != nil && result.Payload != nil && result.Payload.NumRecords != nil && *result.Payload.NumRecords == 1 && result.Payload.SvmResponseInlineRecords != nil {
48224838
return result.Payload.SvmResponseInlineRecords[0], nil
48234839
}
4840+
if result != nil && result.Payload != nil && result.Payload.NumRecords != nil && *result.Payload.NumRecords == 0 {
4841+
return nil, errors.NotFoundError("SVM %s not found", svmName)
4842+
}
48244843
return nil, fmt.Errorf("unexpected result")
48254844
}
48264845

‎storage_drivers/ontap/api/ontap_rest_test.go‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4316,6 +4316,65 @@ func mockGetSVMError(w http.ResponseWriter, r *http.Request) {
43164316
json.NewEncoder(w).Encode("")
43174317
}
43184318

4319+
// mockSVMOnlyKnownByName returns an SVM collection handler that matches only the given SVM name,
4320+
// as the partner cluster does after a MetroCluster switchover renames the SVM.
4321+
func mockSVMOnlyKnownByName(knownName string) func(w http.ResponseWriter, r *http.Request) {
4322+
return func(w http.ResponseWriter, r *http.Request) {
4323+
svmResponse := models.SvmResponse{
4324+
SvmResponseInlineRecords: []*models.Svm{},
4325+
NumRecords: new(int64(0)),
4326+
}
4327+
if r.URL.Query().Get("name") == knownName {
4328+
svmResponse.SvmResponseInlineRecords = []*models.Svm{{UUID: new("1234"), Name: new(knownName)}}
4329+
svmResponse.NumRecords = new(int64(1))
4330+
}
4331+
setHTTPResponseHeader(w, http.StatusOK)
4332+
json.NewEncoder(w).Encode(svmResponse)
4333+
}
4334+
}
4335+
4336+
func TestOntapRest_EnsureSVMWithRest_MetroClusterAlternateName(t *testing.T) {
4337+
tests := []struct {
4338+
name string
4339+
configuredSVM string
4340+
knownSVM string
4341+
expectedSVM string
4342+
isErrorExpected bool
4343+
}{
4344+
{"SwitchoverRenamesSVM", "svm0", "svm0-mc", "svm0-mc", false},
4345+
{"SwitchbackRestoresSVMName", "svm0-mc", "svm0", "svm0", false},
4346+
{"NeitherNameExists", "svm0", "other", "svm0", true},
4347+
}
4348+
for _, test := range tests {
4349+
t.Run(test.name, func(t *testing.T) {
4350+
storageDriverConfig := drivers.OntapStorageDriverConfig{SVM: test.configuredSVM}
4351+
server := httptest.NewServer(http.HandlerFunc(mockSVMOnlyKnownByName(test.knownSVM)))
4352+
defer server.Close()
4353+
rs := newRestClient(server.Listener.Addr().String(), server.Client())
4354+
assert.NotNil(t, rs)
4355+
4356+
err := EnsureSVMWithRest(ctx, &storageDriverConfig, rs)
4357+
assert.Equal(t, test.expectedSVM, storageDriverConfig.SVM)
4358+
if test.isErrorExpected {
4359+
assert.Error(t, err)
4360+
} else {
4361+
assert.NoError(t, err)
4362+
assert.Equal(t, test.expectedSVM, rs.SVMName())
4363+
assert.Equal(t, "1234", rs.SVMUUID())
4364+
}
4365+
})
4366+
}
4367+
}
4368+
4369+
func TestOntapREST_SvmGetByName_NotFound(t *testing.T) {
4370+
server := httptest.NewServer(http.HandlerFunc(mockSVMOnlyKnownByName("other")))
4371+
defer server.Close()
4372+
rs := newRestClient(server.Listener.Addr().String(), server.Client())
4373+
4374+
_, err := rs.SvmGetByName(ctx, "svm0")
4375+
assert.True(t, errors.IsNotFoundError(err), "expected not found error, got %v", err)
4376+
}
4377+
43194378
func TestOntapRest_EnsureSVMWithRest(t *testing.T) {
43204379
tests := []struct {
43214380
name string

‎storage_drivers/ontap/ontap_common_test.go‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -812,6 +812,14 @@ func TestEnsureSVMWithRest(t *testing.T) {
812812
).AnyTimes()
813813
err = api.EnsureSVMWithRest(ctx, ontapConfig, mockRestClient)
814814
assert.Nil(t, err)
815+
816+
// ////////////////////////////////////////////////////////////////////////////////////////////////////////////
817+
// negative case: SVM set && lookup returns no SVM and no error
818+
ontapConfig.SVM = "mySVM"
819+
mockRestClient = newMockRestClient(t)
820+
mockRestClient.EXPECT().SvmGetByName(ctx, "mySVM").Return(nil, nil)
821+
err = api.EnsureSVMWithRest(ctx, ontapConfig, mockRestClient)
822+
assert.ErrorContains(t, err, "unable to get details for SVM mySVM; no SVM returned")
815823
}
816824

817825
func TestSanitizeDataLIF(t *testing.T) {

0 commit comments

Comments
 (0)