Fixed review comments

Author: tamilmani1989

cni/network/plugin/main.go

@@ -23,51 +23,60 @@ const (
 // Version is populated by make during build.
 var version string
 
+// If report write succeeded, mark the report flag state to false.
+func markSendReport(reportManager *telemetry.ReportManager) {
+	if err := reportManager.Report.SetReportState(); err != nil {
+		log.Printf("SetReportState failed due to %v", err)
+		reportManager.Report.ErrorMessage = err.Error()
+
+		if reportManager.SendReport() != nil {
+			log.Printf("SendReport failed due to %v", err)
+		}
+	}
+}
+
+// send error report to hostnetagent if CNI encounters any error.
+func reportPluginError(reportManager *telemetry.ReportManager, err error) {
+	log.Printf("Report plugin error")
+	reportManager.GetReport(pluginName, version)
+	reportManager.Report.ErrorMessage = err.Error()
+
+	if err = reportManager.SendReport(); err != nil {
+		log.Printf("SendReport failed due to %v", err)
+	} else {
+		markSendReport(reportManager)
+	}
+}
+
 // Main is the entry point for CNI network plugin.
 func main() {
 	var config common.PluginConfig
 	var err error
 	config.Version = version
-
-	reportManager := &telemetry.ReportManager{HostNetAgentURL: hostNetAgentURL, IpamQueryURL: ipamQueryURL, ReportType: reportType}
-
-	reportManager.Report, err = reportManager.GetReport(pluginName, config.Version)
-	if err != nil {
-		log.Printf("GetReport failed due to %v", err)
-		reportManager.Report.ErrorMessage = err.Error()
+	reportManager := &telemetry.ReportManager{
+		HostNetAgentURL: hostNetAgentURL,
+		IpamQueryURL:    ipamQueryURL,
+		ReportType:      reportType,
+		Report:          &telemetry.Report{},
 	}
 
-	report := reportManager.Report
-
-	if !report.GetReportState() {
+	if !reportManager.Report.GetReportState() {
 		log.Printf("GetReport state file didn't exist. Setting flag to true")
-
-		report.Context = "AzureCNI"
+		reportManager.GetReport(pluginName, config.Version)
+		reportManager.Report.Context = "AzureCNI"
 
 		err = reportManager.SendReport()
 		if err != nil {
 			log.Printf("SendReport failed due to %v", err)
 		} else {
-			if err = report.SetReportState(); err != nil {
-				log.Printf("SetReportState failed due to %v", err)
-
-				report.ErrorMessage = err.Error()
-				if reportManager.SendReport() != nil {
-					log.Printf("SendReport failed due to %v", err)
-				}
-			}
+			markSendReport(reportManager)
 		}
 	}
 
 	netPlugin, err := network.NewPlugin(&config)
 	if err != nil {
 		log.Printf("Failed to create network plugin, err:%v.\n", err)
-
-		report.ErrorMessage = err.Error()
-		if err = reportManager.SendReport(); err != nil {
-			log.Printf("SendReport failed due to %v", err)
-		}
-
+		reportPluginError(reportManager, err)
 		os.Exit(1)
 	}
 
@@ -76,21 +85,14 @@ func main() {
 	err = netPlugin.Start(&config)
 	if err != nil {
 		log.Printf("Failed to start network plugin, err:%v.\n", err)
-
-		report.ErrorMessage = err.Error()
-		if err = reportManager.SendReport(); err != nil {
-			log.Printf("SendReport failed due to %v", err)
-		}
-
+		reportPluginError(reportManager, err)
 		os.Exit(1)
 	}
 
 	err = netPlugin.Execute(cni.PluginApi(netPlugin))
 	if err != nil {
-		report.ErrorMessage = err.Error()
-		if err = reportManager.SendReport(); err != nil {
-			log.Printf("SendReport failed due to %v", err)
-		}
+		log.Printf("Failed to execute network plugin, err:%v.\n", err)
+		reportPluginError(reportManager, err)
 	}
 
 	netPlugin.Stop()

telemetry/telemetry.go

@@ -4,12 +4,20 @@
 package telemetry
 
 import (
+	"bufio"
 	"bytes"
 	"encoding/json"
+	"encoding/xml"
 	"fmt"
+	"io"
 	"log"
+	"net"
 	"net/http"
 	"os"
+	"os/exec"
+	"strings"
+
+	"github.com/Azure/azure-container-networking/common"
 )
 
 // OS Details structure.
@@ -18,6 +26,7 @@ type OSInfo struct {
 	OSVersion      string
 	KernelVersion  string
 	OSDistribution string
+	ErrorMessage   string
 }
 
 // System Details structure.
@@ -28,6 +37,7 @@ type SystemInfo struct {
 	DiskVMTotal      uint64
 	DiskVMFree       uint64
 	CPUCount         int
+	ErrorMessage     string
 }
 
 // Interface Details structure.
@@ -39,34 +49,37 @@ type InterfaceInfo struct {
 	Name                  string
 	SecondaryCATotalCount int
 	SecondaryCAUsedCount  int
+	ErrorMessage          string
 }
 
 // CNI Bridge Details structure.
 type BridgeInfo struct {
-	NetworkMode string
-	BridgeName  string
+	NetworkMode  string
+	BridgeName   string
+	ErrorMessage string
 }
 
 // Orchestrator Details structure.
 type OrchsestratorInfo struct {
 	OrchestratorName    string
 	OrchestratorVersion string
+	ErrorMessage        string
 }
 
 // Azure CNI Telemetry Report structure.
 type Report struct {
 	StartFlag           bool
 	Name                string
 	Version             string
+	ErrorMessage        string
+	Context             string
+	SubContext          string
+	VnetAddressSpace    []string
 	OrchestratorDetails *OrchsestratorInfo
 	OSDetails           *OSInfo
 	SystemDetails       *SystemInfo
 	InterfaceDetails    *InterfaceInfo
 	BridgeDetails       *BridgeInfo
-	VnetAddressSpace    []string
-	ErrorMessage        string
-	Context             string
-	SubContext          string
 }
 
 // ReportManager structure.
@@ -77,31 +90,47 @@ type ReportManager struct {
 	Report          *Report
 }
 
-// GetReport retrieves orchestrator, system, OS and Interface details and create a report structure.
-func (reportMgr *ReportManager) GetReport(name string, version string) (*Report, error) {
-	var err error
-	report := &Report{}
-
-	report.Name = name
-	report.Version = version
-	report.OrchestratorDetails = GetOrchestratorDetails()
+// Read file line by line and return array of lines.
+func ReadFileByLines(filename string) ([]string, error) {
+	var (
+		lineStrArr []string
+	)
 
-	report.SystemDetails, err = GetSystemDetails()
+	f, err := os.Open(filename)
 	if err != nil {
-		return report, err
+		return nil, fmt.Errorf("Error opening %s file error %v", filename, err)
 	}
 
-	report.OSDetails, err = GetOSDetails()
-	if err != nil {
-		return report, err
+	r := bufio.NewReader(f)
+
+	for {
+		lineStr, err := r.ReadString('\n')
+		if err != nil {
+			if err != io.EOF {
+				return nil, fmt.Errorf("Error reading %s file error %v", filename, err)
+			}
+			break
+		}
+		lineStrArr = append(lineStrArr, lineStr)
 	}
 
-	report.InterfaceDetails, err = GetInterfaceDetails(reportMgr.IpamQueryURL)
+	err = f.Close()
 	if err != nil {
-		return report, err
+		return nil, fmt.Errorf("Error closing %s file error %v", filename, err)
 	}
 
-	return report, nil
+	return lineStrArr, nil
+}
+
+// GetReport retrieves orchestrator, system, OS and Interface details and create a report structure.
+func (reportMgr *ReportManager) GetReport(name string, version string) {
+	reportMgr.Report.Name = name
+	reportMgr.Report.Version = version
+
+	reportMgr.Report.GetOrchestratorDetails()
+	reportMgr.Report.GetSystemDetails()
+	reportMgr.Report.GetOSDetails()
+	reportMgr.Report.GetInterfaceDetails(reportMgr.IpamQueryURL)
 }
 
 // This function will send telemetry report to HostNetAgent.
@@ -112,9 +141,17 @@ func (reportMgr *ReportManager) SendReport() error {
 	json.NewEncoder(&body).Encode(reportMgr.Report)
 
 	log.Printf("Going to send Telemetry report to hostnetagent %v", reportMgr.HostNetAgentURL)
-	log.Printf("Flag %v Name %v Version %v orchestname %s ErrorMessage %v SystemDetails %v OSDetails %v InterfaceDetails %v",
-		reportMgr.Report.StartFlag, reportMgr.Report.Name, reportMgr.Report.Version, reportMgr.Report.OrchestratorDetails, reportMgr.Report.ErrorMessage,
-		reportMgr.Report.SystemDetails, reportMgr.Report.OSDetails, reportMgr.Report.InterfaceDetails)
+
+	log.Printf(`"Start Flag %v Name %v Version %v ErrorMessage %v vnet %v 
+				Context %v SubContext %v"`, reportMgr.Report.StartFlag, reportMgr.Report.Name,
+		reportMgr.Report.Version, reportMgr.Report.ErrorMessage, reportMgr.Report.VnetAddressSpace,
+		reportMgr.Report.Context, reportMgr.Report.SubContext)
+
+	log.Printf("OrchestratorDetails %v", reportMgr.Report.OrchestratorDetails)
+	log.Printf("OSDetails %v", reportMgr.Report.OSDetails)
+	log.Printf("SystemDetails %v", reportMgr.Report.SystemDetails)
+	log.Printf("InterfaceDetails %v", reportMgr.Report.InterfaceDetails)
+	log.Printf("BridgeDetails %v", reportMgr.Report.BridgeDetails)
 
 	res, err := httpc.Post(reportMgr.HostNetAgentURL, reportMgr.ReportType, &body)
 	if err != nil {
@@ -166,3 +203,107 @@ func (report *Report) GetReportState() bool {
 
 	return true
 }
+
+// This function  creates a report with interface details(ip, mac, name, secondaryca count).
+func (report *Report) GetInterfaceDetails(queryUrl string) {
+
+	var (
+		macAddress       string
+		secondaryCACount int
+		primaryCA        string
+		subnet           string
+		ifName           string
+	)
+
+	if queryUrl == "" {
+		report.InterfaceDetails.ErrorMessage = "IpamQueryUrl is null"
+		return
+	}
+
+	interfaces, err := net.Interfaces()
+	if err != nil {
+		report.InterfaceDetails = &InterfaceInfo{}
+		report.InterfaceDetails.ErrorMessage = "Getting all interfaces failed due to " + err.Error()
+		return
+	}
+
+	resp, err := http.Get(queryUrl)
+	if err != nil {
+		report.InterfaceDetails = &InterfaceInfo{}
+		report.InterfaceDetails.ErrorMessage = "Http get failed in getting interface details " + err.Error()
+		return
+	}
+
+	defer resp.Body.Close()
+
+	// Decode XML document.
+	var doc common.XmlDocument
+	decoder := xml.NewDecoder(resp.Body)
+	err = decoder.Decode(&doc)
+	if err != nil {
+		report.InterfaceDetails = &InterfaceInfo{}
+		report.InterfaceDetails.ErrorMessage = "xml decode failed due to " + err.Error()
+		return
+	}
+
+	// For each interface...
+	for _, i := range doc.Interface {
+		i.MacAddress = strings.ToLower(i.MacAddress)
+
+		if i.IsPrimary {
+			// Find the interface with the matching MacAddress.
+			for _, iface := range interfaces {
+				macAddr := strings.Replace(iface.HardwareAddr.String(), ":", "", -1)
+				macAddr = strings.ToLower(macAddr)
+				if macAddr == i.MacAddress {
+					ifName = iface.Name
+					macAddress = iface.HardwareAddr.String()
+				}
+			}
+
+			for _, s := range i.IPSubnet {
+				for _, ip := range s.IPAddress {
+					if ip.IsPrimary {
+						primaryCA = ip.Address
+						subnet = s.Prefix
+					} else {
+						secondaryCACount += 1
+					}
+				}
+			}
+
+			break
+		}
+	}
+
+	report.InterfaceDetails = &InterfaceInfo{
+		InterfaceType:         "Primary",
+		MAC:                   macAddress,
+		Subnet:                subnet,
+		Name:                  ifName,
+		PrimaryCA:             primaryCA,
+		SecondaryCATotalCount: secondaryCACount,
+	}
+}
+
+// This function  creates a report with orchestrator details(name, version).
+func (report *Report) GetOrchestratorDetails() {
+	out, err := exec.Command("kubectl", "--version").Output()
+	if err != nil {
+		report.OrchestratorDetails = &OrchsestratorInfo{}
+		report.OrchestratorDetails.ErrorMessage = "kubectl command failed due to " + err.Error()
+		return
+	}
+
+	outStr := string(out)
+	outStr = strings.TrimLeft(outStr, " ")
+	report.OrchestratorDetails = &OrchsestratorInfo{}
+
+	resultArray := strings.Split(outStr, " ")
+	if len(resultArray) >= 2 {
+		report.OrchestratorDetails.OrchestratorName = resultArray[0]
+		report.OrchestratorDetails.OrchestratorVersion = resultArray[1]
+	} else {
+		report.OrchestratorDetails.ErrorMessage = "Length of array is less than 2"
+	}
+}