endpointGroup inspect support

Author: gaurav-dalvi

Makefile

@@ -203,9 +203,9 @@ host-unit-test-coverage-detail:
 
 host-integ-test: host-cleanup
 	@echo dev: running integration tests...
-	sudo -E /usr/local/go/bin/go test -v ./test/integration/ -check.vv -encap vlan -fwd-mode bridge
-	sudo -E /usr/local/go/bin/go test -v ./test/integration/ -check.vv -encap vxlan -fwd-mode bridge
-	sudo -E /usr/local/go/bin/go test -v ./test/integration/ -check.vv -encap vxlan -fwd-mode routing
+	sudo -E /usr/local/go/bin/go test -v ./test/integration/ -check.v -encap vlan -fwd-mode bridge
+	sudo -E /usr/local/go/bin/go test -v ./test/integration/ -check.v -encap vxlan -fwd-mode bridge
+	sudo -E /usr/local/go/bin/go test -v ./test/integration/ -check.v -encap vxlan -fwd-mode routing
 
 host-cleanup:
 	@echo dev: cleaning up services...

netctl/commands.go

@@ -66,6 +66,13 @@ var Commands = []cli.Command{
 				},
 				Action: createEndpointGroup,
 			},
+			{
+				Name:      "inspect",
+				Usage:     "Inspect a EndpointGroup",
+				ArgsUsage: "[group]",
+				Flags:     []cli.Flag{tenantFlag, jsonFlag},
+				Action:    inspectEndpointGroup,
+			},
 			{
 				Name:      "rm",
 				Aliases:   []string{"delete"},

netctl/netctl.go

@@ -580,6 +580,22 @@ func createEndpointGroup(ctx *cli.Context) {
 	fmt.Printf("Creating EndpointGroup %s:%s\n", tenant, group)
 }
 
+func inspectEndpointGroup(ctx *cli.Context) {
+	argCheck(1, ctx)
+
+	tenant := ctx.String("tenant")
+	endpointGroup := ctx.Args()[0]
+
+	fmt.Printf("Inspeting endpointGroup: %s tenant: %s\n", endpointGroup, tenant)
+
+	epg, err := getClient(ctx).EndpointGroupInspect(tenant, endpointGroup)
+	errCheck(ctx, err)
+
+	content, err := json.MarshalIndent(epg, "", "  ")
+	os.Stdout.Write(content)
+	os.Stdout.WriteString("\n")
+}
+
 func deleteEndpointGroup(ctx *cli.Context) {
 	argCheck(1, ctx)
 

netmaster/objApi/apiController.go

@@ -803,7 +803,58 @@ func (ac *APIController) EndpointGroupUpdate(endpointGroup, params *contivModel.
 	return nil
 }
 
-// EndpointGroupDelete deletes endpoint group
+// EndpointGroupGetOper inspects endpointGroup
+func (ac *APIController) EndpointGroupGetOper(endpointGroup *contivModel.EndpointGroupInspect) error {
+	log.Infof("Received EndpointGroupInspect: %+v", endpointGroup)
+
+	// Get the state driver
+	stateDriver, err := utils.GetStateDriver()
+	if err != nil {
+		return err
+	}
+
+	epgCfg := &mastercfg.EndpointGroupState{}
+	epgCfg.StateDriver = stateDriver
+	epgID := endpointGroup.Config.GroupName + ":" + endpointGroup.Config.TenantName
+	if err := epgCfg.Read(epgID); err != nil {
+		log.Errorf("Error fetching endpointGroup from mastercfg: %s", epgID)
+		return err
+	}
+
+	endpointGroup.Oper.ExternalPktTag = epgCfg.ExtPktTag
+	endpointGroup.Oper.PktTag = epgCfg.PktTag
+	endpointGroup.Oper.NumEndpoints = epgCfg.EpCount
+
+	readEp := &mastercfg.CfgEndpointState{}
+	readEp.StateDriver = stateDriver
+	epCfgs, err := readEp.ReadAll()
+	if err == nil {
+		for _, epCfg := range epCfgs {
+			ep := epCfg.(*mastercfg.CfgEndpointState)
+			if ep.EndpointGroupKey == epgID {
+				epOper := contivModel.EndpointOper{}
+				epOper.Network = ep.NetID
+				epOper.EndpointID = ep.EndpointID
+				epOper.ServiceName = ep.ServiceName
+				epOper.EndpointGroupID = ep.EndpointGroupID
+				epOper.EndpointGroupKey = ep.EndpointGroupKey
+				epOper.IpAddress = []string{ep.IPAddress, ep.IPv6Address}
+				epOper.MacAddress = ep.MacAddress
+				epOper.HomingHost = ep.HomingHost
+				epOper.IntfName = ep.IntfName
+				epOper.VtepIP = ep.VtepIP
+				epOper.Labels = fmt.Sprintf("%s", ep.Labels)
+				epOper.ContainerID = ep.ContainerID
+				epOper.ContainerName = ep.ContainerName
+				endpointGroup.Oper.Endpoints = append(endpointGroup.Oper.Endpoints, epOper)
+			}
+		}
+	}
+
+	return nil
+}
+
+// EndpointGroupDelete deletes end point group
 func (ac *APIController) EndpointGroupDelete(endpointGroup *contivModel.EndpointGroup) error {
 	log.Infof("Received EndpointGroupDelete: %+v", endpointGroup)
 
@@ -917,7 +968,7 @@ func (ac *APIController) NetworkCreate(network *contivModel.Network) error {
 	return nil
 }
 
-// NetworkGetOper updates network
+// NetworkGetOper inspects network
 func (ac *APIController) NetworkGetOper(network *contivModel.NetworkInspect) error {
 	log.Infof("Received NetworkInspect: %+v", network)
 
@@ -1749,8 +1800,3 @@ func validatePorts(ports []string) bool {
 	}
 	return true
 }
-
-// EndpointGroupGetOper returns nil
-func (ac *APIController) EndpointGroupGetOper(endpointGroup *contivModel.EndpointGroupInspect) error {
-	return nil
-}

test/integration/endpoint_test.go

@@ -213,3 +213,92 @@ func (its *integTestSuite) TestEndpointGroupCreateDelete(c *C) {
 
 	assertNoErr(its.client.NetworkDelete("default", "test"), c, "deleting network")
 }
+
+// TestEndpointGroupInspect test endpointGroup inspect command
+func (its *integTestSuite) TestEndpointGroupInspect(c *C) {
+	// Create a network
+	err := its.client.NetworkPost(&client.Network{
+		TenantName:  "default",
+		NetworkName: "test",
+		Subnet:      "10.1.1.0/24",
+		Encap:       its.encap,
+	})
+	assertNoErr(err, c, "creating network")
+
+	// Create a epg
+	err = its.client.EndpointGroupPost(&client.EndpointGroup{
+		TenantName:  "default",
+		NetworkName: "test",
+		GroupName:   "epgA",
+	})
+	assertNoErr(err, c, "creating endpointgroup")
+
+	// verify endpointGroup state is correct
+	insp, err := its.client.EndpointGroupInspect("default", "epgA")
+	assertNoErr(err, c, "inspecting endpointGroup")
+	log.Infof("Inspecting endpointGroup: %+v", insp)
+	c.Assert(len(insp.Oper.Endpoints), Equals, 0)
+	c.Assert(insp.Oper.PktTag, Equals, 1)
+	c.Assert(insp.Oper.NumEndpoints, Equals, 0)
+
+	for i := 0; i < its.iterations; i++ {
+		addr, err := its.allocAddress("", "test.default", "")
+		assertNoErr(err, c, "allocating address")
+		c.Assert(addr, Equals, "10.1.1.1")
+
+		// create an endpoint in epg
+		epCfg1, err := its.createEndpoint("default", "test", "epgA", addr, "")
+		assertNoErr(err, c, "creating endpoint")
+
+		// verify endpointGroup & endpoint inspect output
+		insp, err := its.client.EndpointGroupInspect("default", "epgA")
+		assertNoErr(err, c, "inspecting endpointGroup")
+		log.Infof("Inspecting endpointGroup: %+v", insp)
+		c.Assert(len(insp.Oper.Endpoints), Equals, 1)
+		c.Assert(insp.Oper.NumEndpoints, Equals, 1)
+
+		// verify the endpoint inspect and flow
+		its.verifyEndpointInspect("default", "test", epCfg1, c)
+		its.verifyEndpointFlow(epCfg1, c)
+
+		// allocate a specific address
+		addr, err = its.allocAddress("", "test.default", "10.1.1.5")
+		assertNoErr(err, c, "allocating address")
+		c.Assert(addr, Equals, "10.1.1.5")
+
+		// create an endpoint in epg
+		epCfg2, err := its.createEndpoint("default", "test", "epgA", addr, "")
+		assertNoErr(err, c, "creating endpoint")
+
+		// verify network & endpoint inspect output
+		insp, err = its.client.EndpointGroupInspect("default", "epgA")
+		assertNoErr(err, c, "inspecting endpointGroup")
+		log.Infof("Inspecting endpointGroup: %+v", insp)
+		c.Assert(len(insp.Oper.Endpoints), Equals, 2)
+		c.Assert(insp.Oper.NumEndpoints, Equals, 2)
+
+		// verify endpoint inspect and flows is added
+		its.verifyEndpointInspect("default", "test", epCfg2, c)
+		its.verifyEndpointFlow(epCfg2, c)
+
+		// delete the endpoints
+		err = its.deleteEndpoint("default", "test", "", epCfg1)
+		assertNoErr(err, c, "deleting endpoint")
+		err = its.deleteEndpoint("default", "test", "", epCfg2)
+		assertNoErr(err, c, "deleting endpoint")
+
+		// verify there are no more endpoints in epg
+		insp, err = its.client.EndpointGroupInspect("default", "epgA")
+		assertNoErr(err, c, "inspecting endpointGroup")
+		c.Assert(len(insp.Oper.Endpoints), Equals, 0)
+		log.Infof("Inspecting endpointGroup: %+v", insp)
+		c.Assert(len(insp.Oper.Endpoints), Equals, 0)
+		c.Assert(insp.Oper.NumEndpoints, Equals, 0)
+
+		// verify flows are also gone
+		its.verifyEndpointFlowRemoved(epCfg1, c)
+		its.verifyEndpointFlowRemoved(epCfg2, c)
+	}
+
+	assertNoErr(its.client.EndpointGroupDelete("default", "epgA"), c, "deleting endpointGroup")
+}

test/integration/utils_test.go

@@ -294,7 +294,13 @@ func (its *integTestSuite) verifyEndpointFlow(epCfg *mastercfg.CfgEndpointState,
 	assertNoErr(err, c, "dumping flow entries")
 
 	// verify dst group entry exists
-	dstGrpFmt := fmt.Sprintf("nw_dst=%s actions=write_metadata:%d/0xfffe", epCfg.IPAddress, epCfg.EndpointGroupID)
+	var dstGrpFmt string
+	if epCfg.EndpointGroupID == 0 {
+		dstGrpFmt = fmt.Sprintf("nw_dst=%s actions=write_metadata:0/0xfffe", epCfg.IPAddress)
+	} else {
+		dstGrpFmt = fmt.Sprintf("nw_dst=%s actions=write_metadata:0x%x/0xfffe", epCfg.IPAddress, (epCfg.EndpointGroupID << 1))
+	}
+
 	dstGrpTbl := ofnet.DST_GRP_TBL_ID
 	c.Assert(ofctlFlowMatch(ofdump, dstGrpTbl, dstGrpFmt), Equals, true)