docs: add the development guide and fix the lint

kubeovn · Feb 3, 2020 · 1159873 · 1159873
1 parent 0be2551
commit 1159873
Show file tree

Hide file tree

Showing 14 changed files with 60 additions and 27 deletions.
diff --git a/Makefile b/Makefile
@@ -6,11 +6,15 @@ ROLES=node controller cni db webhook pinger
 DEV_TAG=dev
 RELEASE_TAG=$(shell cat VERSION)
 
-.PHONY: build-dev-images build-go build-bin test lint up down halt suspend resume kind
+.PHONY: build-dev-images build-go build-bin test lint up down halt suspend resume kind push-dev push-release
 
 build-dev-images: build-bin
 	@for role in ${ROLES} ; do \
 		docker build -t ${REGISTRY}/kube-ovn-$$role:${DEV_TAG} -f dist/images/Dockerfile.$$role dist/images/; \
+	done
+
+push-dev:
+	@for role in ${ROLES} ; do \
 		docker push ${REGISTRY}/kube-ovn-$$role:${DEV_TAG}; \
 	done
 
@@ -21,9 +25,13 @@ build-go:
 	CGO_ENABLED=0 GOOS=linux go build -o $(PWD)/dist/images/kube-ovn-webhook -ldflags "-w -s" -v ./cmd/webhook
 	CGO_ENABLED=0 GOOS=linux go build -o $(PWD)/dist/images/kube-ovn-pinger -ldflags "-w -s" -v ./cmd/pinger
 
-release: build-go
+release: lint build-go
 	@for role in ${ROLES} ; do \
 		docker build -t ${REGISTRY}/kube-ovn-$$role:${RELEASE_TAG} -f dist/images/Dockerfile.$$role dist/images/; \
+	done
+
+push-release:
+	@for role in ${ROLES} ; do \
 		docker push ${REGISTRY}/kube-ovn-$$role:${RELEASE_TAG}; \
 	done
 
@@ -35,14 +43,13 @@ lint:
 test:
 	GOOS=linux go test -cover -v ./...
 
-build-bin: lint
+build-bin:
 	docker run --rm -e GOOS=linux -e GOCACHE=/tmp \
 		-u $(shell id -u):$(shell id -g) \
 		-v $(CURDIR):/go/src/github.com/alauda/kube-ovn:ro \
 		-v $(CURDIR)/dist:/go/src/github.com/alauda/kube-ovn/dist/ \
 		golang:$(GO_VERSION) /bin/bash -c '\
 		cd /go/src/github.com/alauda/kube-ovn && \
-		make test && \
 		make build-go '
 
 up:

diff --git a/README.md b/README.md
@@ -67,6 +67,12 @@ If you want to install Kubernetes from scratch, you can try [kubespray](https://
 - [Tracing/Diagnose/Dump Traffic with Kubectl Plugin](docs/kubectl-plugin.md)
 - [Prometheus Integration](docs/prometheus.md)
 
+
+## Contribution
+We are looking forwards to your PR!
+
+- [Development Guide](docs/development.md)
+
 ## Companies using Kube-OVN
 
 Not in the list? Open a pull request and add yourself!

diff --git a/cmd/cni/cni.go b/cmd/cni/cni.go
@@ -71,7 +71,7 @@ func generateCNIResult(cniVersion string, cniResponse *request.CniResponse) curr
 
 		route := types.Route{
 			Dst: net.IPNet{IP: net.ParseIP("0.0.0.0").To4(), Mask: net.CIDRMask(0, 32)},
-			GW: net.ParseIP(cniResponse.Gateway).To4(),
+			GW:  net.ParseIP(cniResponse.Gateway).To4(),
 		}
 		result.Routes = []*types.Route{&route}
 	case kubeovnv1.ProtocolIPv6:
@@ -84,7 +84,7 @@ func generateCNIResult(cniVersion string, cniResponse *request.CniResponse) curr
 
 		route := types.Route{
 			Dst: net.IPNet{IP: net.ParseIP("::").To16(), Mask: net.CIDRMask(0, 128)},
-			GW: net.ParseIP(cniResponse.Gateway).To16(),
+			GW:  net.ParseIP(cniResponse.Gateway).To16(),
 		}
 		result.Routes = []*types.Route{&route}
 	}

diff --git a/cmd/controller/controller.go b/cmd/controller/controller.go
@@ -46,7 +46,7 @@ func loopOvnNbctlDaemon(config *controller.Configuration) {
 
 		// ovn-nbctl daemon may hang and cannot precess further request.
 		// In case of that, we need to start a new daemon.
-		if  err := ovs.CheckAlive(); err != nil {
+		if err := ovs.CheckAlive(); err != nil {
 			klog.Warningf("ovn-nbctl daemon doesn't return, start a new daemon")
 			ovs.StartOvnNbctlDaemon(config.OvnNbHost, config.OvnNbPort)
 		}

diff --git a/cmd/webhook/server.go b/cmd/webhook/server.go
@@ -101,7 +101,7 @@ func loopOvnNbctlDaemon(ovnNbHost string, ovnNbPort int) {
 			ovs.StartOvnNbctlDaemon(ovnNbHost, ovnNbPort)
 		}
 
-		if  err := ovs.CheckAlive(); err != nil {
+		if err := ovs.CheckAlive(); err != nil {
 			klog.Warningf("ovn-nbctl daemon doesn't return, start a new daemon")
 			ovs.StartOvnNbctlDaemon(ovnNbHost, ovnNbPort)
 		}

diff --git a/docs/development.md b/docs/development.md
@@ -0,0 +1,23 @@
+# Development Guide
+
+## How to build Kube-OVN
+
+Kube-OVN is developed by [Go](https://golang.org/) and uses [Go Modules](https://github.com/golang/go/wiki/Modules) to manage dependency.
+
+```
+git clone https://github.com/alauda/kube-ovn.git
+cd kube-ovn
+make release
+```
+
+## How to run e2e tests
+
+Kube-OVN uses [KIND](https://kind.sigs.k8s.io/) to setup a local Kubernetes cluster 
+and [Ginkgo](https://onsi.github.io/ginkgo/) as the test framework to run the e2e tests.
+
+```
+make kind-init
+# wait all pod ready
+
+make e2e
+```
diff --git a/pkg/controller/controller.go b/pkg/controller/controller.go
@@ -445,7 +445,7 @@ func (c *Controller) gcLogicalSwitchPort() error {
 		klog.Errorf("failed to list node, %v", err)
 		return err
 	}
-	ipNames := make([]string, 0, len(pods) + len(nodes))
+	ipNames := make([]string, 0, len(pods)+len(nodes))
 	for _, pod := range pods {
 		ipNames = append(ipNames, fmt.Sprintf("%s.%s", pod.Name, pod.Namespace))
 	}

diff --git a/pkg/controller/subnet.go b/pkg/controller/subnet.go
@@ -264,7 +264,7 @@ func formatSubnet(subnet *kubeovnv1.Subnet, c *Controller) error {
 	changed := false
 	_, ipNet, err := net.ParseCIDR(subnet.Spec.CIDRBlock)
 	if err != nil {
-		return fmt.Errorf("subnet %s cidr %s is not a valid cidrblock", subnet.Name, subnet.Spec.CIDRBlock )
+		return fmt.Errorf("subnet %s cidr %s is not a valid cidrblock", subnet.Name, subnet.Spec.CIDRBlock)
 	}
 	if ipNet.String() != subnet.Spec.CIDRBlock {
 		subnet.Spec.CIDRBlock = ipNet.String()

diff --git a/pkg/ovs/ovn-nbctl.go b/pkg/ovs/ovn-nbctl.go
@@ -600,7 +600,7 @@ func StartOvnNbctlDaemon(nbHost string, nbPort int) (string, error) {
 		"pkill",
 		"-f",
 		"ovn-nbctl",
-		).CombinedOutput()
+	).CombinedOutput()
 	if err != nil {
 		klog.Errorf("failed to kill old ovn-nbctl daemon: %q", output)
 		return "", err

diff --git a/pkg/pinger/ping.go b/pkg/pinger/ping.go
@@ -149,7 +149,7 @@ func pingExternal(config *Configuration) {
 func nslookup(config *Configuration) {
 	klog.Infof("start to check dns connectivity")
 	t1 := time.Now()
-	ctx, cancel := context.WithTimeout(context.TODO(), 10 * time.Second)
+	ctx, cancel := context.WithTimeout(context.TODO(), 10*time.Second)
 	defer cancel()
 	var r net.Resolver
 	addrs, err := r.LookupHost(ctx, config.DNS)

diff --git a/test/e2e/e2e_suite_test.go b/test/e2e/e2e_suite_test.go
@@ -17,8 +17,6 @@ import (
 	_ "github.com/alauda/kube-ovn/test/e2e/subnet"
 )
 
-
-
 func TestE2e(t *testing.T) {
 	RegisterFailHandler(Fail)
 	RunSpecs(t, "Kube-OVN E2E Suite")

diff --git a/test/e2e/framework/framework.go b/test/e2e/framework/framework.go
@@ -15,10 +15,10 @@ import (
 )
 
 type Framework struct {
-	BaseName string
+	BaseName         string
 	KubeOvnNamespace string
-	KubeClientSet kubernetes.Interface
-	OvnClientSet  clientset.Interface
+	KubeClientSet    kubernetes.Interface
+	OvnClientSet     clientset.Interface
 }
 
 func NewFramework(baseName, kubeConfig string) *Framework {
@@ -77,7 +77,6 @@ func (f *Framework) WaitPodReady(pod, namespace string) error {
 			return nil
 		}
 
-
 		switch getPodStatus(p) {
 		case Completed:
 			return fmt.Errorf("pod already completed")

diff --git a/test/e2e/ip/static_ip.go b/test/e2e/ip/static_ip.go
@@ -28,10 +28,10 @@ var _ = Describe("[IP Allocation]", func() {
 			autoMount := false
 			pod := &corev1.Pod{
 				ObjectMeta: metav1.ObjectMeta{
-					Name:        name,
-					Namespace:   namespace,
+					Name:      name,
+					Namespace: namespace,
 					Annotations: map[string]string{
-						util.IpAddressAnnotation: "12.10.0.10",
+						util.IpAddressAnnotation:  "12.10.0.10",
 						util.MacAddressAnnotation: "00:00:00:53:6B:B6",
 					},
 				},

diff --git a/test/e2e/subnet/normal.go b/test/e2e/subnet/normal.go
@@ -29,7 +29,7 @@ var _ = Describe("[Subnet]", func() {
 			By("create subnet")
 			s := kubeovn.Subnet{
 				ObjectMeta: metav1.ObjectMeta{
-					Name: name,
+					Name:   name,
 					Labels: map[string]string{"e2e": "true"},
 				},
 				Spec: kubeovn.SubnetSpec{
@@ -68,11 +68,11 @@ var _ = Describe("[Subnet]", func() {
 			By("create subnet")
 			s := kubeovn.Subnet{
 				ObjectMeta: metav1.ObjectMeta{
-					Name: name,
+					Name:   name,
 					Labels: map[string]string{"e2e": "true"},
 				},
 				Spec: kubeovn.SubnetSpec{
-					CIDRBlock: "11.11.0.0/16",
+					CIDRBlock:   "11.11.0.0/16",
 					GatewayType: kubeovn.GWCentralizedType,
 					GatewayNode: "kube-ovn-control-plane,kube-ovn-worker,kube-ovn-worker2",
 				},
@@ -97,7 +97,7 @@ var _ = Describe("[Subnet]", func() {
 			By("create subnet")
 			s := &kubeovn.Subnet{
 				ObjectMeta: metav1.ObjectMeta{
-					Name: name,
+					Name:   name,
 					Labels: map[string]string{"e2e": "true"},
 				},
 				Spec: kubeovn.SubnetSpec{
@@ -132,7 +132,7 @@ var _ = Describe("[Subnet]", func() {
 			By("create subnet")
 			s := kubeovn.Subnet{
 				ObjectMeta: metav1.ObjectMeta{
-					Name: name,
+					Name:   name,
 					Labels: map[string]string{"e2e": "true"},
 				},
 				Spec: kubeovn.SubnetSpec{
@@ -155,7 +155,7 @@ var _ = Describe("[Subnet]", func() {
 			By("create subnet")
 			s := &kubeovn.Subnet{
 				ObjectMeta: metav1.ObjectMeta{
-					Name: name,
+					Name:   name,
 					Labels: map[string]string{"e2e": "true"},
 				},
 				Spec: kubeovn.SubnetSpec{