Have a single external contracts array at epg level and changes around that.

Author: Satish Ramachandran

netctl/commands.go

@@ -56,12 +56,8 @@ var Commands = []cli.Command{
 						Usage: "Policy List (separated by commas)",
 					},
 					cli.StringFlag{
-						Name:  "consumed-external-contracts, i",
-						Usage: "Consumed external contracts(separated by commas)",
-					},
-					cli.StringFlag{
-						Name:  "provided-external-contracts, e",
-						Usage: "Provided external contracts(separated by commas)",
+						Name:  "external-contracts, e",
+						Usage: "External contracts(separated by commas)",
 					},
 				},
 				Action: createEndpointGroup,

netctl/netctl.go

@@ -401,23 +401,17 @@ func createEndpointGroup(ctx *cli.Context) {
 		policies = []string{}
 	}
 
-	consExtContractsGrps := strings.Split(ctx.String("consumed-external-contracts"), ",")
-	if ctx.String("consumed-external-contracts") == "" {
-		consExtContractsGrps = []string{}
-	}
-
-	provExtContractsGrps := strings.Split(ctx.String("provided-external-contracts"), ",")
-	if ctx.String("provided-external-contracts") == "" {
-		provExtContractsGrps = []string{}
+	extContractsGrps := strings.Split(ctx.String("external-contracts"), ",")
+	if ctx.String("external-contracts") == "" {
+		extContractsGrps = []string{}
 	}
 
 	errCheck(ctx, getClient(ctx).EndpointGroupPost(&contivClient.EndpointGroup{
-		TenantName:           tenant,
-		NetworkName:          network,
-		GroupName:            group,
-		Policies:             policies,
-		ConsExtContractsGrps: consExtContractsGrps,
-		ProvExtContractsGrps: provExtContractsGrps,
+		TenantName:       tenant,
+		NetworkName:      network,
+		GroupName:        group,
+		Policies:         policies,
+		ExtContractsGrps: extContractsGrps,
 	}))
 }
 

netmaster/objApi/apiController.go

@@ -428,7 +428,7 @@ func (ac *APIController) EndpointGroupCreate(endpointGroup *contivModel.Endpoint
 	}
 
 	// Setup external contracts this EPG might have.
-	err = setupExternalContracts(endpointGroup, endpointGroup.ConsExtContractsGrps, endpointGroup.ProvExtContractsGrps)
+	err = setupExternalContracts(endpointGroup, endpointGroup.ExtContractsGrps)
 	if err != nil {
 		log.Errorf("Error setting up external contracts for epg %s", endpointGroup.Key)
 		endpointGroupCleanup(endpointGroup)
@@ -537,14 +537,13 @@ func (ac *APIController) EndpointGroupUpdate(endpointGroup, params *contivModel.
 	}
 	// Step 2: Add contracts from the update.
 	// Consumed contracts
-	err = setupExternalContracts(endpointGroup, params.ConsExtContractsGrps, params.ProvExtContractsGrps)
+	err = setupExternalContracts(endpointGroup, params.ExtContractsGrps)
 	if err != nil {
 		return err
 	}
 
 	// Update the epg itself with the new contracts groups.
-	endpointGroup.ConsExtContractsGrps = params.ConsExtContractsGrps
-	endpointGroup.ProvExtContractsGrps = params.ProvExtContractsGrps
+	endpointGroup.ExtContractsGrps = params.ExtContractsGrps
 
 	// if there is an associated app profiles, update that as well
 	profKey := endpointGroup.Links.AppProfile.ObjKey

netmaster/objApi/extContracts.go

@@ -21,88 +21,29 @@ import (
 	"github.com/contiv/contivmodel"
 	"github.com/contiv/netplugin/core"
 	"github.com/contiv/objdb/modeldb"
-	"strings"
 )
 
 // Some utility functions to work with the external contracts
-// Severe the connections between EPGs and external contracts.
-func extContractsGrpDeregister(epg *contivModel.EndpointGroup,
-	contractsGrp *contivModel.ExtContractsGroup,
-	contractType string) error {
-	if contractsGrp == nil {
-		errStr := fmt.Sprintf("%s External contracts group not found", contractType)
-		log.Errorf(errStr)
-		return core.Errorf(errStr)
-	}
-
-	modeldb.RemoveLinkSet(&contractsGrp.LinkSets.EndpointGroups, epg)
-	modeldb.RemoveLinkSet(&epg.LinkSets.ExtContractsGrps, contractsGrp)
-
-	// Links broken, update the contracts group object.
-	err := contractsGrp.Write()
-	if err != nil {
-		return err
-	}
-
-	return nil
-}
-
-// Check for the presence of external contracts, and also make sure that
-// they are of the right type. If yes, establish necessary relationships
-// between the epg and the external contracts.
-func extContractsGrpValidateAndRegister(epg *contivModel.EndpointGroup,
-	contractsGrp *contivModel.ExtContractsGroup,
-	contractType string) error {
-	if contractsGrp == nil {
-		errStr := fmt.Sprintf("%s External contracts group not found", contractType)
-		log.Errorf(errStr)
-		return core.Errorf(errStr)
-	}
-
-	if strings.ToLower(contractsGrp.ContractsType) != contractType {
-		errStr := fmt.Sprintf("Incorrect type for contract group: %v", contractsGrp)
-		log.Errorf(errStr)
-		return core.Errorf(errStr)
-	}
-
-	// Establish the necessary links.
-	modeldb.AddLinkSet(&contractsGrp.LinkSets.EndpointGroups, epg)
-	modeldb.AddLinkSet(&epg.LinkSets.ExtContractsGrps, contractsGrp)
-
-	// Links made, write the policy set object.
-	err := contractsGrp.Write()
-	if err != nil {
-		return err
-	}
-
-	return nil
-}
 
 // Cleanup external contracts from an epg.
 func cleanupExternalContracts(endpointGroup *contivModel.EndpointGroup) error {
-	// Cleanup consumed external contracts
 	tenant := endpointGroup.TenantName
-	for _, consExtContractsGrp := range endpointGroup.ConsExtContractsGrps {
-		contractsGrpKey := tenant + ":" + consExtContractsGrp
-		contractsGrp := contivModel.FindExtContractsGroup(contractsGrpKey)
-		err := extContractsGrpDeregister(endpointGroup, contractsGrp, "consumed")
-		if err != nil {
-			if contractsGrp != nil {
-				log.Errorf("Error cleaning up consumed ext contract %s", contractsGrp.ContractsGroupName)
-			}
-			continue
-		}
-	}
-
-	// Cleanup provided external contracts
-	for _, provExtContractsGrp := range endpointGroup.ProvExtContractsGrps {
-		contractsGrpKey := tenant + ":" + provExtContractsGrp
-		contractsGrp := contivModel.FindExtContractsGroup(contractsGrpKey)
-		err := extContractsGrpDeregister(endpointGroup, contractsGrp, "provided")
-		if err != nil {
-			if contractsGrp != nil {
-				log.Errorf("Error cleaning up provided ext contract %s", contractsGrp.ContractsGroupName)
+	for _, contractsGrp := range endpointGroup.ExtContractsGrps {
+		contractsGrpKey := tenant + ":" + contractsGrp
+		contractsGrpObj := contivModel.FindExtContractsGroup(contractsGrpKey)
+
+		if contractsGrpObj != nil {
+			// Break any linkeage we might have set.
+			modeldb.RemoveLinkSet(&contractsGrpObj.LinkSets.EndpointGroups, endpointGroup)
+			modeldb.RemoveLinkSet(&endpointGroup.LinkSets.ExtContractsGrps, contractsGrpObj)
+
+			// Links broken, update the contracts group object.
+			err := contractsGrpObj.Write()
+			if err != nil {
+				return err
 			}
+		} else {
+			log.Errorf("Error cleaning up consumed ext contract %s", contractsGrp)
 			continue
 		}
 	}
@@ -111,24 +52,25 @@ func cleanupExternalContracts(endpointGroup *contivModel.EndpointGroup) error {
 }
 
 // Setup external contracts for an epg.
-func setupExternalContracts(endpointGroup *contivModel.EndpointGroup,
-	consContractsGrps, provContractsGrps []string) error {
+func setupExternalContracts(endpointGroup *contivModel.EndpointGroup, extContractsGrps []string) error {
 	// Validate presence and register consumed external contracts
 	tenant := endpointGroup.TenantName
-	for _, consExtContractsGrp := range consContractsGrps {
-		contractsGrpKey := tenant + ":" + consExtContractsGrp
-		contractsGrp := contivModel.FindExtContractsGroup(contractsGrpKey)
-		err := extContractsGrpValidateAndRegister(endpointGroup, contractsGrp, "consumed")
-		if err != nil {
-			return err
+	for _, contractsGrp := range extContractsGrps {
+		contractsGrpKey := tenant + ":" + contractsGrp
+		contractsGrpObj := contivModel.FindExtContractsGroup(contractsGrpKey)
+
+		if contractsGrpObj == nil {
+			errStr := fmt.Sprintf("%External contracts group %s not found", contractsGrp)
+			log.Errorf(errStr)
+			return core.Errorf(errStr)
 		}
-	}
 
-	// Validate presence and register provided external contracts
-	for _, provExtContractsGrp := range provContractsGrps {
-		contractsGrpKey := tenant + ":" + provExtContractsGrp
-		contractsGrp := contivModel.FindExtContractsGroup(contractsGrpKey)
-		err := extContractsGrpValidateAndRegister(endpointGroup, contractsGrp, "provided")
+		// Establish the necessary links.
+		modeldb.AddLinkSet(&contractsGrpObj.LinkSets.EndpointGroups, endpointGroup)
+		modeldb.AddLinkSet(&endpointGroup.LinkSets.ExtContractsGrps, contractsGrpObj)
+
+		// Links made, write the policy set object.
+		err := contractsGrpObj.Write()
 		if err != nil {
 			return err
 		}

netmaster/objApi/infraproxy.go

@@ -169,26 +169,28 @@ func appendEpgInfo(eMap *epgMap, epgObj *contivModel.EndpointGroup, stateDriver
 
 	}
 
-	// Append external consumed contracts.
-	for _, contractGrp := range epgObj.ConsExtContractsGrps {
-		contractGrpObj := contivModel.FindExtContractsGroup(contractGrp)
-		if contractGrpObj == nil {
-			errStr := fmt.Sprintf("Consumed contracts %v not found for epg: %v", contractGrp, epg.Name)
+	// Append external contracts.
+	tenant := epgObj.TenantName
+	for _, contractsGrp := range epgObj.ExtContractsGrps {
+		contractsGrpKey := tenant + ":" + contractsGrp
+		contractsGrpObj := contivModel.FindExtContractsGroup(contractsGrpKey)
+
+		if contractsGrpObj == nil {
+			errStr := fmt.Sprintf("Contracts %v not found for epg: %v", contractsGrp, epg.Name)
 			return errors.New(errStr)
 		}
-		epg.ConsContracts = append(epg.ConsContracts, contractGrpObj.Contracts...)
-	}
-	log.Debugf("Copied over %d externally defined consumed contracts", len(epg.ConsContracts))
-
-	// Append external provided contracts.
-	for _, contractGrp := range epgObj.ProvExtContractsGrps {
-		contractGrpObj := contivModel.FindExtContractsGroup(contractGrp)
-		if contractGrpObj == nil {
-			errStr := fmt.Sprintf("Provided contracts %v not found for epg: %v", contractGrp, epg.Name)
+		if contractsGrpObj.ContractsType == "consumed" {
+			epg.ConsContracts = append(epg.ConsContracts, contractsGrpObj.Contracts...)
+		} else if contractsGrpObj.ContractsType == "provided" {
+			epg.ProvContracts = append(epg.ProvContracts, contractsGrpObj.Contracts...)
+		} else {
+			// Should not be here.
+			errStr := fmt.Sprintf("Invalid contracts type %v", contractsGrp)
 			return errors.New(errStr)
 		}
-		epg.ProvContracts = append(epg.ProvContracts, contractGrpObj.Contracts...)
 	}
+
+	log.Debugf("Copied over %d externally defined consumed contracts", len(epg.ConsContracts))
 	log.Debugf("Copied over %d externally defined provided contracts", len(epg.ProvContracts))
 
 	// add any saved uses info before overwriting