Merge pull request #1054 from HeshanSudarshana/4.2.x-apictl-param-for…

…mat-issue

[4.2.x] Add validation for empty configs value for params file

import-export-cli/impl/importAPI.go

@@ -289,7 +289,7 @@ func envParamsFileProcess(importPath, paramsPath, importEnvironment string) erro
 }
 
 // envParamsDirectoryProcess function is used to process the environment parameters when they are provided as a
-//directory
+// directory
 func envParamsDirectoryProcess(importPath, paramsPath, importEnvironment string) error {
 	apiParams, err := params.LoadApiParamsFromDirectory(paramsPath)
 	if err != nil {
@@ -362,6 +362,10 @@ func handleCustomizedParameters(importPath, paramsPath, importEnvironment string
 // Process env params and create the intermediate_params.yaml file to pass to the server
 func handleEnvParams(tempDirectory string, destDirectory string, environmentParams *params.Environment) error {
 	// read api params from external parameters file
+	if len(environmentParams.Config) == 0 {
+		return errors.New("configs value is empty in the provided parameters")
+	}
+
 	envParamsJson, err := jsoniter.Marshal(environmentParams.Config)
 	if err != nil {
 		return err

import-export-cli/integration/envSpecific_test.go

@@ -63,6 +63,29 @@ func TestEnvironmentSpecificParamsEndpoint(t *testing.T) {
 	}
 }
 
+// Try to import an API with the external params file with invalid format (missing the configs key)
+func TestInvalidEnvironmentSpecificParamsEndpoint(t *testing.T) {
+	for _, user := range testCaseUsers {
+		t.Run(user.Description, func(t *testing.T) {
+			dev := GetDevClient()
+			prod := GetProdClient()
+
+			api := testutils.AddAPI(t, dev, user.ApiCreator.Username, user.ApiCreator.Password)
+
+			args := &testutils.ApiImportExportTestArgs{
+				ApiProvider: testutils.Credentials{Username: user.ApiCreator.Username, Password: user.ApiCreator.Password},
+				CtlUser:     testutils.Credentials{Username: user.CtlUser.Username, Password: user.CtlUser.Password},
+				Api:         api,
+				SrcAPIM:     dev,
+				DestAPIM:    prod,
+				ParamsFile:  testutils.InvalidAPIEndpointParamsFile,
+			}
+
+			testutils.ValidateAPIImportFailure(t, args)
+		})
+	}
+}
+
 // Add an API to one environment, export it and re-import it to another environment by setting
 // the configs for endpoints using the params file
 func TestEnvironmentSpecificParamsEndpointConfigs(t *testing.T) {

import-export-cli/integration/testdata/EnvParamsFiles/invalid_api_params_endpoint.yaml

@@ -0,0 +1,7 @@
+environments:
+    - name: production
+      endpoints:
+          production:
+              url: 'https://prod.wso2.com'
+          sandbox:
+              url: 'https://sand.wso2.com'

import-export-cli/integration/testutils/testConstants.go

@@ -18,7 +18,7 @@
 
 package testutils
 
-//Environment management related test constants
+// Environment management related test constants
 const ApictlInitMessage = "apictl is a Command Line Tool for Importing and Exporting APIs and Applications between " +
 	"different environments of WSO2 API Manager"
 const CustomTestExportDirectory = "CustomExportDirectory"
@@ -34,7 +34,7 @@ const TestMigrationDirectorySuffix = "/migration"
 
 const DefaultApictlTestAppName = "default-apictl-app"
 
-//Export test cases
+// Export test cases
 const DevFirstDefaultAPIName = "SwaggerPetstoreNew"
 const DevFirstSwagger2APIName = "PizzaShackAPI"
 const OpenAPI3DefinitionWithoutEndpointsAPIName = "PizzaShackAPI"
@@ -136,6 +136,9 @@ const APIAwsEndpointWithStoredCredentialsParamsFile = EnvParamsFilesDir + "/api_
 // APIDynamicEndpointParamsFile : Dynamic Endpoint with stored credentials in api_params.yaml
 const APIDynamicEndpointParamsFile = EnvParamsFilesDir + "/api_params_dynamic_endpoint.yaml"
 
+// InvalidAPIEndpointParamsFile : Invalid Endpoint URL api_params.yaml
+const InvalidAPIEndpointParamsFile = EnvParamsFilesDir + "/invalid_api_params_endpoint.yaml"
+
 // API types
 const APITypeREST = "HTTP"
 const APITypeSoap = "SOAP"