Skip to content
Permalink
Browse files

Add check-conformance-test-requirements.go

We have defined requirements of conformance test as [1], and this
adds coding check for one requirement "it works for all providers".

[1]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/conformance-tests.md#conformance-test-requirements
  • Loading branch information...
oomichi committed Mar 20, 2019
1 parent aa5fda2 commit 127cf314d1c8e5991855a944605c37e3881e8d74
Showing with 169 additions and 0 deletions.
  1. +14 −0 hack/conformance/BUILD
  2. +155 −0 hack/conformance/check_conformance_test_requirements.go
@@ -0,0 +1,14 @@
load("@io_bazel_rules_go//go:def.bzl", "go_binary", "go_library")

go_library(
name = "go_default_library",
srcs = ["check_conformance_test_requirements.go"],
importpath = "k8s.io/kubernetes/hack/conformance",
visibility = ["//visibility:private"],
)

go_binary(
name = "conformance",
embed = [":go_default_library"],
visibility = ["//visibility:public"],
)
@@ -0,0 +1,155 @@
/*
Copyright 2019 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

// This tool is for checking conformance e2e tests follow the requirements
// which is https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/conformance-tests.md#conformance-test-requirements
package main

import (
"bufio"
"bytes"
"fmt"
"io/ioutil"
"os"
"regexp"

"github.com/pkg/errors"
"github.com/spf13/cobra"
)

const (
//e.g. framework.ConformanceIt("should provide secure master service ", func() {
patternStartConformance = "framework.ConformanceIt\\(.*, func\\(\\) {$"
patternEndConformance = "}\\)$"
patternSkipProviderIs = "Skip.*ProviderIs\\("
)

var exitCode = 0

// This function checks the requirement: it works for all providers (e.g., no SkipIfProviderIs/SkipUnlessProviderIs calls)
func checkAllProviders(e2eFile string) error {
inConformanceCode := false

regStartConformance := regexp.MustCompile(patternStartConformance)
regEndConformance := regexp.MustCompile(patternEndConformance)
regSkipProviderIs := regexp.MustCompile(patternSkipProviderIs)

fileInput, err := ioutil.ReadFile(e2eFile)
if err != nil {
fmt.Printf(os.Stderr, "Failed to read file %s: %v\n", e2eFile, err)
return err
}
scanner := bufio.NewScanner(bytes.NewReader(fileInput))
scanner.Split(bufio.ScanLines)

for scanner.Scan() {
line := scanner.Text()
if regStartConformance.MatchString(line) {
if inConformanceCode {
return errors.Errorf("Missed the end of previous conformance test. There might be a bug in this script.")
}
inConformanceCode = true
}
if inConformanceCode {
if regSkipProviderIs.MatchString(line) {
// To list all invalid places in a single operation of this tool, here doesn't return error and continues checking.
fmt.Printf(os.Stderr, "%v: Conformance test should not call SkipIfProviderIs()/SkipUnlessProviderIs()\n", e2eFile)
exitCode = 1
}
if regEndConformance.MatchString(line) {
inConformanceCode = false
}
}
}
if inConformanceCode {
return errors.Errorf("Missed the end of previous conformance test. There might be a bug in this script.")
}
return nil
}

func processFile(e2ePath string) error {
regGoFile := regexp.MustCompile(".*.go")

files, err := ioutil.ReadDir(e2ePath)
if err != nil {
fmt.Printf(os.Stderr, "Failed to read dir %s: %v\n", e2ePath, err)
return err
}
for _, file := range files {
if file.IsDir() {
continue
}
if !regGoFile.MatchString(file.Name()) {
continue
}
e2eFile := fmt.Sprintf("%s/%s", e2ePath, file.Name())
err = checkAllProviders(e2eFile)
if err != nil {
return err
}
}
return nil
}

func processDir(e2ePath string) error {
err := processFile(e2ePath)
if err != nil {
return err
}

// Search sub directories if exist
files, err := ioutil.ReadDir(e2ePath)
if err != nil {
fmt.Printf(os.Stderr, "Failed to read dir %s: %v\n", e2ePath, err)
return err
}
for _, file := range files {
if !file.IsDir() {
continue
}
err = processDir(fmt.Sprintf("%s/%s", e2ePath, file.Name()))
if err != nil {
return err
}
}
return nil
}

func newCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "check_conformance_test_requirements [e2e-test-path]",
Short: "Check conformance test code follows the requirements",
Run: func(cmd *cobra.Command, args []string) {
if len(args) != 1 {
cmd.Help()
os.Exit(1)
}
e2eRootPath := args[0]
err := processDir(e2eRootPath)
if err != nil {
fmt.Printf(os.Stderr, "Failed to process directory %s: %v\n", e2eRootPath, err)
os.Exit(1)
}
os.Exit(exitCode)
},
}
return cmd
}

func main() {
checkCommand := newCommand()
checkCommand.Execute()
}

0 comments on commit 127cf31

Please sign in to comment.
You can’t perform that action at this time.