Merge pull request #877 from wasuradananjith/master

Bumping the REST API versions and update the license text

Author: wasuradananjith

import-export-cli/LICENSE.txt

@@ -39,6 +39,8 @@ github.com/pavel-v-chernykh/keystore-go/v4
 
 github.com/renstrom/dedent                                                                          MIT
 
+github.com/savaki/jq                                                                                Apache-2.0
+
 github.com/spf13/cast                                                                               MIT
 
 github.com/spf13/cobra                                                                              Apache-2.0

import-export-cli/impl/getKeys.go

@@ -404,7 +404,7 @@ func subscribe(appId string, accessToken string) (string, error) {
 // @param accessToken : Access token to call the REST API
 // @return API, error
 func getApiOrProduct(apiId string, accessToken string) (*utils.APIData, error) {
-	// Since apis/{api-id} supports retrieving details of both APIs and API Products, we can use it here.
+	// First check whether this is an API
 	apiEndpoint := utils.GetApiListEndpointOfEnv(keyGenEnv, utils.MainConfigFilePath) + "/" + apiId
 	headers := make(map[string]string)
 	headers[utils.HeaderAuthorization] = utils.HeaderValueAuthBearerPrefix + " " + accessToken
@@ -416,13 +416,26 @@ func getApiOrProduct(apiId string, accessToken string) (*utils.APIData, error) {
 		err = json.Unmarshal(data, &apiData)
 		return apiData, err
 	} else {
-		utils.Logf("Error: %s\n", resp.Error())
-		utils.Logf("Body: %s\n", resp.Body())
-		if resp.StatusCode() == http.StatusUnauthorized {
-			// 401 Unauthorized
-			return nil, fmt.Errorf("authorization failed while trying to retrieve the details of API or API Prodcut: " + apiId)
+		// Second check whether this is an API Product
+		apiProductEndpoint := utils.GetApiProductListEndpointOfEnv(keyGenEnv, utils.MainConfigFilePath) + "/" + apiId
+		headers := make(map[string]string)
+		headers[utils.HeaderAuthorization] = utils.HeaderValueAuthBearerPrefix + " " + accessToken
+		resp, err := utils.InvokeGETRequest(apiProductEndpoint, headers)
+		if resp.StatusCode() == http.StatusOK || resp.StatusCode() == http.StatusCreated {
+			// 200 OK or 201 Created
+			apiData := &utils.APIData{}
+			data := []byte(resp.Body())
+			err = json.Unmarshal(data, &apiData)
+			return apiData, err
+		} else {
+			utils.Logf("Error: %s\n", resp.Error())
+			utils.Logf("Body: %s\n", resp.Body())
+			if resp.StatusCode() == http.StatusUnauthorized {
+				// 401 Unauthorized
+				return nil, fmt.Errorf("authorization failed while trying to retrieve the details of API or API Prodcut: " + apiId)
+			}
+			return nil, errors.New("Request didn't respond 200 OK for retrieving API or API Product details. Status: " + resp.Status())
 		}
-		return nil, errors.New("Request didn't respond 200 OK for retrieving API or API Product details. Status: " + resp.Status())
 	}
 }
 

import-export-cli/integration/README.md

@@ -37,11 +37,14 @@ indexing-delay: 1000
 
 - *APIM DCR/REST API versions*
 
-   The DCR and REST API version of the APIM instances mentioned previously.
+   The DCR and REST API versions (Admin, Devportal and Publisher) of the APIM instances mentioned previously.
 
 ```
 dcr-version: v0.17
-rest-api-version: v2
+admin-rest-api-version: v3
+devportal-rest-api-version: v2
+publisher-rest-api-version: v3
+devops-rest-api-version: v0
 ```
 
 - *apictl version*

import-export-cli/integration/advertiseOnlyApi_test.go renamed to import-export-cli/integration/advertiseOnlyApi-comment.go

@@ -1197,7 +1197,7 @@ func TestDeleteApiProductWithActiveSubscriptionsSuperTenantUser(t *testing.T) {
 	base.WaitForIndexing()
 
 	//Get keys for ApiProduct and keep subscription active
-	testutils.ValidateGetKeysWithoutCleanup(t, args, true)
+	testutils.ValidateGetKeysWithoutCleanup(t, args, false)
 
 	argsToDelete := &testutils.ApiProductImportExportTestArgs{
 		CtlUser:    testutils.Credentials{Username: adminUsername, Password: adminPassword},

import-export-cli/integration/apiProduct_test.go

@@ -231,13 +231,20 @@ type RoleBindings struct {
 
 // APIOperations : API Operations definition
 type APIOperations struct {
-	ID               string   `json:"id"`
-	Target           string   `json:"target"`
-	Verb             string   `json:"verb"`
-	AuthType         string   `json:"authType,omitempty"`
-	ThrottlingPolicy string   `json:"throttlingPolicy,omitempty"`
-	Scopes           []string `json:"scopes,omitempty"`
-	UsedProductIds   []string `json:"usedProductIds,omitempty"`
+	ID                string            `json:"id" yaml:"id"`
+	Target            string            `json:"target" yaml:"target"`
+	Verb              string            `json:"verb" yaml:"verb"`
+	AuthType          string            `json:"authType,omitempty" yaml:"authType,omitempty"`
+	ThrottlingPolicy  string            `json:"throttlingPolicy,omitempty" yaml:"throttlingPolicy,omitempty"`
+	Scopes            []string          `json:"scopes,omitempty" yaml:"scopes,omitempty"`
+	UsedProductIds    []string          `json:"usedProductIds,omitempty" yaml:"usedProductIds,omitempty"`
+	OperationPolicies OperationPolicies `json:"operationPolicies,omitempty" yaml:"operationPolicies,omitempty"`
+}
+
+type OperationPolicies struct {
+	Request  interface{} `json:"request" yaml:"request"`
+	Response interface{} `json:"response" yaml:"response"`
+	Fault    interface{} `json:"fault" yaml:"fault"`
 }
 
 // AdvertiseInfo : Advertise only information

import-export-cli/integration/apim/apiDTO.go

@@ -110,14 +110,16 @@ func (instance *Client) Login(username string, password string) {
 }
 
 // Setup : Setup APIM Client config
-func (instance *Client) Setup(envName string, host string, offset int, dcrVersion, restAPIVersion, devopsRestAPIVersion string) {
+func (instance *Client) Setup(envName string, host string, offset int, dcrVersion, adminRestAPIVersion,
+	devportalRestAPIVersion, publisherRestAPIVersion, devopsRestAPIVersion string) {
 	base.Log("apim.Setup() - envName:", envName, ",host:", host, ",offset:", offset, ",dcrVersion:", dcrVersion,
-		",restAPIVersion:", restAPIVersion)
+		",adminRestAPIVersion:", adminRestAPIVersion, ",devportalRestAPIVersion:", devportalRestAPIVersion,
+		",publisherRestAPIVersion:", publisherRestAPIVersion)
 	instance.apimURL = getApimURL(host, offset)
 	instance.dcrURL = getDCRURL(host, dcrVersion, offset)
-	instance.devPortalRestURL = getDevPortalRestURL(host, restAPIVersion, offset)
-	instance.publisherRestURL = getPublisherRestURL(host, restAPIVersion, offset)
-	instance.adminRestURL = getAdminRestURL(host, restAPIVersion, offset)
+	instance.devPortalRestURL = getDevPortalRestURL(host, devportalRestAPIVersion, offset)
+	instance.publisherRestURL = getPublisherRestURL(host, publisherRestAPIVersion, offset)
+	instance.adminRestURL = getAdminRestURL(host, adminRestAPIVersion, offset)
 	instance.devopsRestURL = getDevOpsRestURL(host, devopsRestAPIVersion, offset)
 	instance.portOffset = offset
 	instance.tokenURL = getTokenURL(host, offset)
@@ -1903,35 +1905,41 @@ func (instance *Client) SetAPILogLevel(username, password, tenantDomain, apiId,
 }
 
 func generateSampleAPIOperations() []APIOperations {
+
 	op1 := APIOperations{}
 	op1.Target = "/order/{orderId}"
 	op1.Verb = "GET"
 	op1.ThrottlingPolicy = "Unlimited"
 	op1.AuthType = "Application & Application User"
+	op1.OperationPolicies = OperationPolicies{[]string{}, []string{}, []string{}}
 
 	op2 := APIOperations{}
 	op2.Target = "/order/{orderId}"
 	op2.Verb = "DELETE"
 	op2.ThrottlingPolicy = "Unlimited"
 	op2.AuthType = "Application & Application User"
+	op2.OperationPolicies = OperationPolicies{[]string{}, []string{}, []string{}}
 
 	op3 := APIOperations{}
 	op3.Target = "/order/{orderId}"
 	op3.Verb = "PUT"
 	op3.ThrottlingPolicy = "Unlimited"
 	op3.AuthType = "Application & Application User"
+	op3.OperationPolicies = OperationPolicies{[]string{}, []string{}, []string{}}
 
 	op4 := APIOperations{}
 	op4.Target = "/menu"
 	op4.Verb = "GET"
 	op4.ThrottlingPolicy = "Unlimited"
 	op4.AuthType = "Application & Application User"
+	op4.OperationPolicies = OperationPolicies{[]string{}, []string{}, []string{}}
 
 	op5 := APIOperations{}
 	op5.Target = "/order"
 	op5.Verb = "POST"
 	op5.ThrottlingPolicy = "Unlimited"
 	op5.AuthType = "Application & Application User"
+	op5.OperationPolicies = OperationPolicies{[]string{}, []string{}, []string{}}
 
 	return []APIOperations{op1, op2, op3, op4, op5}
 }

import-export-cli/integration/apim/apim.go

@@ -15,7 +15,9 @@ indexing-delay: 1000
 max-invocation-attempts: 10
 
 dcr-version: v0.17
-rest-api-version: v2
-devops-rest-api-version: v1
+admin-rest-api-version: v3
+devportal-rest-api-version: v2
+publisher-rest-api-version: v3
+devops-rest-api-version: v0
 apictl-version: 4.1.0
 

import-export-cli/integration/config.yaml

@@ -33,13 +33,15 @@ import (
 )
 
 type YamlConfig struct {
-	Environments          []Environment `yaml:"environments"`
-	IndexingDelay         int           `yaml:"indexing-delay"`
-	MaxInvocationAttempts int           `yaml:"max-invocation-attempts"`
-	DCRVersion            string        `yaml:"dcr-version"`
-	RESTAPIVersion        string        `yaml:"rest-api-version"`
-	DevOpsRESTAPIVersion  string        `yaml:"devops-rest-api-version"`
-	APICTLVersion         string        `yaml:"apictl-version"`
+	Environments            []Environment `yaml:"environments"`
+	IndexingDelay           int           `yaml:"indexing-delay"`
+	MaxInvocationAttempts   int           `yaml:"max-invocation-attempts"`
+	DCRVersion              string        `yaml:"dcr-version"`
+	AdminRESTAPIVersion     string        `yaml:"admin-rest-api-version"`
+	DevportalRESTAPIVersion string        `yaml:"devportal-rest-api-version"`
+	PublisherRESTAPIVersion string        `yaml:"publisher-rest-api-version"`
+	DevOpsRESTAPIVersion    string        `yaml:"devops-rest-api-version"`
+	APICTLVersion           string        `yaml:"apictl-version"`
 }
 
 type Environment struct {
@@ -136,7 +138,8 @@ func TestMain(m *testing.M) {
 
 	for _, env := range envs {
 		client := apim.Client{}
-		client.Setup(env.Name, env.Host, env.Offset, yamlConfig.DCRVersion, yamlConfig.RESTAPIVersion, yamlConfig.DevOpsRESTAPIVersion)
+		client.Setup(env.Name, env.Host, env.Offset, yamlConfig.DCRVersion, yamlConfig.AdminRESTAPIVersion,
+			yamlConfig.DevportalRESTAPIVersion, yamlConfig.PublisherRESTAPIVersion, yamlConfig.DevOpsRESTAPIVersion)
 		apimClients[env.Name] = &client
 	}
 
@@ -179,7 +182,9 @@ func readConfigs() {
 	base.Log("indexing delay:", yamlConfig.IndexingDelay)
 	base.Log("max invocation attempts", yamlConfig.MaxInvocationAttempts)
 	base.Log("dcr version:", yamlConfig.DCRVersion)
-	base.Log("rest api Version:", yamlConfig.RESTAPIVersion)
+	base.Log("admin rest api Version:", yamlConfig.AdminRESTAPIVersion)
+	base.Log("devportal rest api Version:", yamlConfig.DevportalRESTAPIVersion)
+	base.Log("publisher rest api Version:", yamlConfig.PublisherRESTAPIVersion)
 	base.Log("apictl version:", yamlConfig.APICTLVersion)
 
 	if len(envs) != 2 {

import-export-cli/integration/devFirst_test.go renamed to import-export-cli/integration/devFirst-commented.go

@@ -82,7 +82,7 @@ data: # Contains the meta data of the API
      - Content-Type
      - SOAPAction
      - apikey
-     - testKey
+     - Internal-Key
     accessControlAllowMethods:  # Allowed methods as a list
      - GET
      - PUT
@@ -119,6 +119,10 @@ data: # Contains the meta data of the API
     throttlingPolicy: Unlimited
     scopes: []
     usedProductIds: []
+    operationPolicies:
+      request: []
+      response: []
+      fault: []
    -
     id: ""
     target: /menu
@@ -127,6 +131,10 @@ data: # Contains the meta data of the API
     throttlingPolicy: Unlimited
     scopes: []
     usedProductIds: []
+    operationPolicies:
+      request: []
+      response: []
+      fault: []
    -
     id: ""
     target: /order/{orderId}
@@ -135,6 +143,10 @@ data: # Contains the meta data of the API
     throttlingPolicy: Unlimited
     scopes: []
     usedProductIds: []
+    operationPolicies:
+      request: []
+      response: []
+      fault: []
    -
     id: ""
     target: /order/{orderId}
@@ -143,6 +155,10 @@ data: # Contains the meta data of the API
     throttlingPolicy: Unlimited
     scopes: []
     usedProductIds: []
+    operationPolicies:
+      request: []
+      response: []
+      fault: []
    -
     id: ""
     target: /order/{orderId}
@@ -151,6 +167,10 @@ data: # Contains the meta data of the API
     throttlingPolicy: Unlimited
     scopes: []
     usedProductIds: []
+    operationPolicies:
+      request: []
+      response: []
+      fault: []
   categories: [] # List of API Categories that the API belongs to
   keyManagers: # List of key manager endpoints
    - all

import-export-cli/integration/integration_test.go

@@ -82,7 +82,7 @@ data: # Contains the meta data of the API
      - Content-Type
      - SOAPAction
      - apikey
-     - testKey
+     - Internal-Key
     accessControlAllowMethods:  # Allowed methods as a list
      - GET
      - PUT
@@ -119,6 +119,10 @@ data: # Contains the meta data of the API
     throttlingPolicy: Unlimited
     scopes: []
     usedProductIds: []
+    operationPolicies:
+      request: []
+      response: []
+      fault: []
    -
     id: ""
     target: /menu
@@ -127,6 +131,10 @@ data: # Contains the meta data of the API
     throttlingPolicy: Unlimited
     scopes: []
     usedProductIds: []
+    operationPolicies:
+      request: []
+      response: []
+      fault: []
    -
     id: ""
     target: /order/{orderId}
@@ -135,6 +143,10 @@ data: # Contains the meta data of the API
     throttlingPolicy: Unlimited
     scopes: []
     usedProductIds: []
+    operationPolicies:
+      request: []
+      response: []
+      fault: []
    -
     id: ""
     target: /order/{orderId}
@@ -143,6 +155,10 @@ data: # Contains the meta data of the API
     throttlingPolicy: Unlimited
     scopes: []
     usedProductIds: []
+    operationPolicies:
+      request: []
+      response: []
+      fault: []
    -
     id: ""
     target: /order/{orderId}
@@ -151,6 +167,10 @@ data: # Contains the meta data of the API
     throttlingPolicy: Unlimited
     scopes: []
     usedProductIds: []
+    operationPolicies:
+      request: []
+      response: []
+      fault: []
   categories: [] # List of API Categories that the API belongs to
   keyManagers: # List of key manager endpoints
    - all

import-export-cli/integration/testdata/sample-api.yaml

@@ -96,19 +96,18 @@ const DeploymentCertificatesDirectory = "certificates"
 var DefaultExportDirPath = filepath.Join(ConfigDirPath, DefaultExportDirName)
 var DefaultCertDirPath = filepath.Join(ConfigDirPath, CertificatesDirName)
 
-const defaultApiApplicationImportExportSuffix = "api/am/admin/v2"
-const defaultPublisherApiImportExportSuffix = "api/am/publisher/v2"
-const defaultApiListEndpointSuffix = "api/am/publisher/v2/apis"
-const defaultApiProductListEndpointSuffix = "api/am/publisher/v2/api-products"
-const defaultUnifiedSearchEndpointSuffix = "api/am/publisher/v2/search"
-const defaultAdminApplicationListEndpointSuffix = "api/am/admin/v2/applications"
+const defaultApiApplicationImportExportSuffix = "api/am/admin/v3"
+const defaultPublisherApiImportExportSuffix = "api/am/publisher/v3"
+const defaultApiListEndpointSuffix = "api/am/publisher/v3/apis"
+const defaultApiProductListEndpointSuffix = "api/am/publisher/v3/api-products"
+const defaultUnifiedSearchEndpointSuffix = "api/am/publisher/v3/search"
+const defaultAdminApplicationListEndpointSuffix = "api/am/admin/v3/applications"
 const defaultDevPortalApplicationListEndpointSuffix = "api/am/devportal/v2/applications"
 const defaultDevPortalThrottlingPoliciesEndpointSuffix = "api/am/devportal/v2/throttling-policies"
 const defaultClientRegistrationEndpointSuffix = "client-registration/v0.17/register"
 const defaultTokenEndPoint = "oauth2/token"
 const defaultRevokeEndpointSuffix = "oauth2/revoke"
-const defaultAPILoggingBaseEndpoint = "api/am/devops/v1/tenant-logs"
-const defaultAPILoggingListEndpoint = "apis?logging-enabled=false"
+const defaultAPILoggingBaseEndpoint = "api/am/devops/v0/tenant-logs"
 const defaultAPILoggingApisEndpoint = "apis"
 
 const DefaultEnvironmentName = "default"

import-export-cli/integration/testdata/sample-revisioned-api.yaml

@@ -287,11 +287,11 @@ func GetAPILoggingListEndpointOfEnv(env, tenantDomain, filePath string) string {
 	envEndpoints, _ := GetEndpointsOfEnvironment(env, filePath)
 	if !(envEndpoints.PublisherEndpoint == "" || envEndpoints == nil) {
 		envEndpoints.PublisherEndpoint = AppendSlashToString(envEndpoints.PublisherEndpoint)
-		return envEndpoints.PublisherEndpoint + defaultAPILoggingBaseEndpoint + "/" + tenantDomain + "/" + defaultAPILoggingListEndpoint
+		return envEndpoints.PublisherEndpoint + defaultAPILoggingBaseEndpoint + "/" + tenantDomain + "/" + defaultAPILoggingApisEndpoint
 	} else {
 		apiManagerEndpoint := GetApiManagerEndpointOfEnv(env, filePath)
 		apiManagerEndpoint = AppendSlashToString(apiManagerEndpoint)
-		return apiManagerEndpoint + defaultAPILoggingBaseEndpoint + "/" + tenantDomain + "/" + defaultAPILoggingListEndpoint
+		return apiManagerEndpoint + defaultAPILoggingBaseEndpoint + "/" + tenantDomain + "/" + defaultAPILoggingApisEndpoint
 	}
 }