Merge pull request #1186 from cloudskiff/fix/sort-scanner

Create a SortableScanner for specific use case

pkg/remote/api_gateway_scanner_test.go

@@ -1,7 +1,6 @@
 package remote
 
 import (
-	"sort"
 	"testing"
 
 	awssdk "github.com/aws/aws-sdk-go/aws"
@@ -16,6 +15,7 @@ import (
 	"github.com/cloudskiff/driftctl/pkg/resource"
 	resourceaws "github.com/cloudskiff/driftctl/pkg/resource/aws"
 	"github.com/cloudskiff/driftctl/pkg/terraform"
+	"github.com/cloudskiff/driftctl/test/remote"
 	testresource "github.com/cloudskiff/driftctl/test/resource"
 	"github.com/pkg/errors"
 	"github.com/stretchr/testify/assert"
@@ -1037,12 +1037,6 @@ func TestApiGatewayMethod(t *testing.T) {
 			assertExpected: func(t *testing.T, got []*resource.Resource) {
 				assert.Len(t, got, 3)
 
-				// We need to sort the slice of resources to have consistent test results because at
-				// the creation we iterate over a map[string]*apigateway.Method.
-				sort.Slice(got, func(i, j int) bool {
-					return got[i].ResourceId() < got[j].ResourceId()
-				})
-
 				assert.Equal(t, got[0].ResourceId(), "agm-vryjzimtj1-hl7ksq-DELETE")
 				assert.Equal(t, got[0].ResourceType(), resourceaws.AwsApiGatewayMethodResourceType)
 
@@ -1094,7 +1088,7 @@ func TestApiGatewayMethod(t *testing.T) {
 			testFilter := &filter.MockFilter{}
 			testFilter.On("IsTypeIgnored", mock.Anything).Return(false)
 
-			s := NewScanner(remoteLibrary, alerter, scanOptions, testFilter)
+			s := remote.NewSortableScanner(NewScanner(remoteLibrary, alerter, scanOptions, testFilter))
 			got, err := s.Resources()
 			assert.Equal(tt, err, c.wantErr)
 			if err != nil {
@@ -1249,12 +1243,6 @@ func TestApiGatewayMethodResponse(t *testing.T) {
 			assertExpected: func(t *testing.T, got []*resource.Resource) {
 				assert.Len(t, got, 3)
 
-				// We need to sort the slice of resources to have consistent test results because at
-				// the creation we iterate over a map[string]*apigateway.MethodResponse.
-				sort.Slice(got, func(i, j int) bool {
-					return got[i].ResourceId() < got[j].ResourceId()
-				})
-
 				assert.Equal(t, got[0].ResourceId(), "agmr-vryjzimtj1-hl7ksq-GET-200")
 				assert.Equal(t, got[0].ResourceType(), resourceaws.AwsApiGatewayMethodResponseResourceType)
 
@@ -1306,7 +1294,7 @@ func TestApiGatewayMethodResponse(t *testing.T) {
 			testFilter := &filter.MockFilter{}
 			testFilter.On("IsTypeIgnored", mock.Anything).Return(false)
 
-			s := NewScanner(remoteLibrary, alerter, scanOptions, testFilter)
+			s := remote.NewSortableScanner(NewScanner(remoteLibrary, alerter, scanOptions, testFilter))
 			got, err := s.Resources()
 			assert.Equal(tt, err, c.wantErr)
 			if err != nil {

pkg/remote/azurerm_privatedns_scanner_test.go

@@ -14,6 +14,7 @@ import (
 	"github.com/cloudskiff/driftctl/pkg/resource"
 	resourceazure "github.com/cloudskiff/driftctl/pkg/resource/azurerm"
 	"github.com/cloudskiff/driftctl/pkg/terraform"
+	"github.com/cloudskiff/driftctl/test/remote"
 	testresource "github.com/cloudskiff/driftctl/test/resource"
 	"github.com/pkg/errors"
 	"github.com/stretchr/testify/assert"
@@ -101,7 +102,7 @@ func TestAzurermPrivateDNSZone(t *testing.T) {
 			testFilter := &filter.MockFilter{}
 			testFilter.On("IsTypeIgnored", mock.Anything).Return(false)
 
-			s := NewScanner(remoteLibrary, alerter, scanOptions, testFilter)
+			s := remote.NewSortableScanner(NewScanner(remoteLibrary, alerter, scanOptions, testFilter))
 			got, err := s.Resources()
 			assert.Equal(tt, c.wantErr, err)
 			if err != nil {

test/remote/scanner.go

@@ -0,0 +1,23 @@
+package remote
+
+import (
+	"github.com/cloudskiff/driftctl/pkg/resource"
+)
+
+type SortableScanner struct {
+	Scanner resource.Supplier
+}
+
+func NewSortableScanner(scanner resource.Supplier) *SortableScanner {
+	return &SortableScanner{
+		Scanner: scanner,
+	}
+}
+
+func (s *SortableScanner) Resources() ([]*resource.Resource, error) {
+	resources, err := s.Scanner.Resources()
+	if err != nil {
+		return nil, err
+	}
+	return resource.Sort(resources), nil
+}