.github/workflows/codeql-analysis.yml

@@ -0,0 +1,67 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '21 7 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'go' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.travis.yml

@@ -1,7 +1,7 @@
 language: go
 go:
-  - 1.13.x
   - 1.14.x
+  - 1.15.x
   - tip
 
 cache:
@@ -16,10 +16,9 @@ install:
   - GO111MODULE="off" go get golang.org/x/tools/cmd/cover
   - GO111MODULE="off" go get github.com/onsi/gomega
   - GO111MODULE="off" go install github.com/onsi/ginkgo/ginkgo
-  - export PATH=$PATH:$HOME/gopath/bin
+  - export PATH=$GOPATH/bin:$PATH
 
 script:
-  - GO111MODULE="on" go mod tidy
-  - diff -u <(echo -n) <(git diff go.mod)
-  - diff -u <(echo -n) <(git diff go.sum)
-  - $HOME/gopath/bin/ginkgo -r --randomizeAllSpecs --randomizeSuites --race --trace && go vet
+  - GO111MODULE="on" go mod tidy && git diff --exit-code go.mod go.sum
+  - go vet
+  - ginkgo -r --randomizeAllSpecs --randomizeSuites --race --trace

CHANGELOG.md

@@ -1,3 +1,14 @@
+## 1.15.0
+
+### Features
+- Adds 'outline' command to print the outline of specs/containers in a file (#754) [071c369] [6803cc3] [935b538] [06744e8] [0c40583]
+- Add support for using template to generate tests (#752) [efb9e69]
+- Add a Chinese Doc #755 (#756) [5207632]
+- cli: allow multiple -focus and -skip flags (#736) [9a782fb]
+
+### Fixes
+- Add _internal to filename of tests created with internal flag (#751) [43c12da]
+
 ## 1.14.2
 
 ### Fixes

README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/onsi/ginkgo.svg?branch=master)](https://travis-ci.org/onsi/ginkgo)
 
-Jump to the [docs](https://onsi.github.io/ginkgo/) to learn more.  To start rolling your Ginkgo tests *now* [keep reading](#set-me-up)!
+Jump to the [docs](https://onsi.github.io/ginkgo/) | [中文文档](https://ke-chain.github.io/ginkgodoc) to learn more.  To start rolling your Ginkgo tests *now* [keep reading](#set-me-up)!
 
 If you have a question, comment, bug report, feature request, etc. please open a GitHub issue, or visit the [Ginkgo Slack channel](https://app.slack.com/client/T029RQSE6/CQQ50BBNW).
 

config/config.go

@@ -20,14 +20,14 @@ import (
 	"fmt"
 )
 
-const VERSION = "1.14.2"
+const VERSION = "1.15.0"
 
 type GinkgoConfigType struct {
 	RandomSeed         int64
 	RandomizeAllSpecs  bool
 	RegexScansFilePath bool
-	FocusString        string
-	SkipString         string
+	FocusStrings       []string
+	SkipStrings        []string
 	SkipMeasurements   bool
 	FailOnPending      bool
 	FailFast           bool
@@ -65,6 +65,11 @@ func processPrefix(prefix string) string {
 	return prefix
 }
 
+type flagFunc func(string)
+
+func (f flagFunc) String() string     { return "" }
+func (f flagFunc) Set(s string) error { f(s); return nil }
+
 func Flags(flagSet *flag.FlagSet, prefix string, includeParallelFlags bool) {
 	prefix = processPrefix(prefix)
 	flagSet.Int64Var(&(GinkgoConfig.RandomSeed), prefix+"seed", time.Now().Unix(), "The seed used to randomize the spec suite.")
@@ -75,8 +80,8 @@ func Flags(flagSet *flag.FlagSet, prefix string, includeParallelFlags bool) {
 
 	flagSet.BoolVar(&(GinkgoConfig.DryRun), prefix+"dryRun", false, "If set, ginkgo will walk the test hierarchy without actually running anything.  Best paired with -v.")
 
-	flagSet.StringVar(&(GinkgoConfig.FocusString), prefix+"focus", "", "If set, ginkgo will only run specs that match this regular expression.")
-	flagSet.StringVar(&(GinkgoConfig.SkipString), prefix+"skip", "", "If set, ginkgo will only run specs that do not match this regular expression.")
+	flagSet.Var(flagFunc(flagFocus), prefix+"focus", "If set, ginkgo will only run specs that match this regular expression. Can be specified multiple times, values are ORed.")
+	flagSet.Var(flagFunc(flagSkip), prefix+"skip", "If set, ginkgo will only run specs that do not match this regular expression. Can be specified multiple times, values are ORed.")
 
 	flagSet.BoolVar(&(GinkgoConfig.RegexScansFilePath), prefix+"regexScansFilePath", false, "If set, ginkgo regex matching also will look at the file path (code location).")
 
@@ -133,12 +138,12 @@ func BuildFlagArgs(prefix string, ginkgo GinkgoConfigType, reporter DefaultRepor
 		result = append(result, fmt.Sprintf("--%sdryRun", prefix))
 	}
 
-	if ginkgo.FocusString != "" {
-		result = append(result, fmt.Sprintf("--%sfocus=%s", prefix, ginkgo.FocusString))
+	for _, s := range ginkgo.FocusStrings {
+		result = append(result, fmt.Sprintf("--%sfocus=%s", prefix, s))
 	}
 
-	if ginkgo.SkipString != "" {
-		result = append(result, fmt.Sprintf("--%sskip=%s", prefix, ginkgo.SkipString))
+	for _, s := range ginkgo.SkipStrings {
+		result = append(result, fmt.Sprintf("--%sskip=%s", prefix, s))
 	}
 
 	if ginkgo.FlakeAttempts > 1 {
@@ -211,3 +216,13 @@ func BuildFlagArgs(prefix string, ginkgo GinkgoConfigType, reporter DefaultRepor
 
 	return result
 }
+
+// flagFocus implements the -focus flag.
+func flagFocus(arg string) {
+	GinkgoConfig.FocusStrings = append(GinkgoConfig.FocusStrings, arg)
+}
+
+// flagSkip implements the -skip flag.
+func flagSkip(arg string) {
+	GinkgoConfig.SkipStrings = append(GinkgoConfig.SkipStrings, arg)
+}

ginkgo/generate_command.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"flag"
 	"fmt"
+	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strconv"
@@ -12,11 +13,15 @@ import (
 )
 
 func BuildGenerateCommand() *Command {
-	var agouti, noDot, internal bool
+	var (
+		agouti, noDot, internal bool
+		customTestFile          string
+	)
 	flagSet := flag.NewFlagSet("generate", flag.ExitOnError)
 	flagSet.BoolVar(&agouti, "agouti", false, "If set, generate will generate a test file for writing Agouti tests")
 	flagSet.BoolVar(&noDot, "nodot", false, "If set, generate will generate a test file that does not . import ginkgo and gomega")
 	flagSet.BoolVar(&internal, "internal", false, "If set, generate will generate a test file that uses the regular package name")
+	flagSet.StringVar(&customTestFile, "template", "", "If specified, generate will use the contents of the file passed as the test file template")
 
 	return &Command{
 		Name:         "generate",
@@ -28,7 +33,7 @@ func BuildGenerateCommand() *Command {
 			"Accepts the following flags:",
 		},
 		Command: func(args []string, additionalArgs []string) {
-			generateSpec(args, agouti, noDot, internal)
+			generateSpec(args, agouti, noDot, internal, customTestFile)
 		},
 	}
 }
@@ -81,9 +86,9 @@ type specData struct {
 	ImportPackage     bool
 }
 
-func generateSpec(args []string, agouti, noDot, internal bool) {
+func generateSpec(args []string, agouti, noDot, internal bool, customTestFile string) {
 	if len(args) == 0 {
-		err := generateSpecForSubject("", agouti, noDot, internal)
+		err := generateSpecForSubject("", agouti, noDot, internal, customTestFile)
 		if err != nil {
 			fmt.Println(err.Error())
 			fmt.Println("")
@@ -95,7 +100,7 @@ func generateSpec(args []string, agouti, noDot, internal bool) {
 
 	var failed bool
 	for _, arg := range args {
-		err := generateSpecForSubject(arg, agouti, noDot, internal)
+		err := generateSpecForSubject(arg, agouti, noDot, internal, customTestFile)
 		if err != nil {
 			failed = true
 			fmt.Println(err.Error())
@@ -107,13 +112,17 @@ func generateSpec(args []string, agouti, noDot, internal bool) {
 	}
 }
 
-func generateSpecForSubject(subject string, agouti, noDot, internal bool) error {
+func generateSpecForSubject(subject string, agouti, noDot, internal bool, customTestFile string) error {
 	packageName, specFilePrefix, formattedName := getPackageAndFormattedName()
 	if subject != "" {
 		specFilePrefix = formatSubject(subject)
 		formattedName = prettifyPackageName(specFilePrefix)
 	}
 
+	if internal {
+		specFilePrefix = specFilePrefix + "_internal"
+	}
+
 	data := specData{
 		Package:           determinePackageName(packageName, internal),
 		Subject:           formattedName,
@@ -136,7 +145,13 @@ func generateSpecForSubject(subject string, agouti, noDot, internal bool) error
 	defer f.Close()
 
 	var templateText string
-	if agouti {
+	if customTestFile != "" {
+		tpl, err := ioutil.ReadFile(customTestFile)
+		if err != nil {
+			panic(err.Error())
+		}
+		templateText = string(tpl)
+	} else if agouti {
 		templateText = agoutiSpecText
 	} else {
 		templateText = specText

ginkgo/main.go

@@ -111,6 +111,11 @@ will output an executable file named `package.test`.  This can be run directly o
 
 	ginkgo <path-to-package.test>
 
+
+To print an outline of Ginkgo specs and containers in a file:
+
+	gingko outline <filename>
+
 To print out Ginkgo's version:
 
 	ginkgo version
@@ -172,6 +177,7 @@ func init() {
 	Commands = append(Commands, BuildUnfocusCommand())
 	Commands = append(Commands, BuildVersionCommand())
 	Commands = append(Commands, BuildHelpCommand())
+	Commands = append(Commands, BuildOutlineCommand())
 }
 
 func main() {

ginkgo/outline/_testdata/alias_test.go

@@ -0,0 +1,50 @@
+package example_test
+
+import (
+	fooginkgo "github.com/onsi/ginkgo"
+	footable "github.com/onsi/ginkgo/extensions/table"
+)
+
+var _ = fooginkgo.Describe("NodotFixture", func() {
+	fooginkgo.Describe("normal", func() {
+		fooginkgo.It("normal", func() {
+			fooginkgo.By("normal")
+			fooginkgo.By("normal")
+
+		})
+	})
+
+	fooginkgo.Context("normal", func() {
+		fooginkgo.It("normal", func() {
+
+		})
+	})
+
+	fooginkgo.When("normal", func() {
+		fooginkgo.It("normal", func() {
+
+		})
+	})
+
+	fooginkgo.It("normal", func() {
+
+	})
+
+	fooginkgo.Specify("normal", func() {
+
+	})
+
+	fooginkgo.Measure("normal", func(b fooginkgo.Benchmarker) {
+
+	}, 2)
+
+	footable.DescribeTable("normal",
+		func() {},
+		footable.Entry("normal"),
+	)
+
+	footable.DescribeTable("normal",
+		func() {},
+		footable.Entry("normal"),
+	)
+})

ginkgo/outline/_testdata/alias_test.go.csv

@@ -0,0 +1,17 @@
+Name,Text,Start,End,Spec,Focused,Pending
+Describe,NodotFixture,130,785,false,false,false
+Describe,normal,175,308,false,false,false
+It,normal,215,304,true,false,false
+By,normal,250,272,false,false,false
+By,normal,276,298,false,false,false
+Context,normal,311,391,false,false,false
+It,normal,350,387,true,false,false
+When,normal,394,471,false,false,false
+It,normal,430,467,true,false,false
+It,normal,474,510,true,false,false
+Specify,normal,513,554,true,false,false
+Measure,normal,557,624,true,false,false
+DescribeTable,normal,627,703,false,false,false
+Entry,normal,675,699,true,false,false
+DescribeTable,normal,706,782,false,false,false
+Entry,normal,754,778,true,false,false

ginkgo/outline/_testdata/alias_test.go.json

@@ -0,0 +1 @@
+[{"name":"Describe","text":"NodotFixture","start":130,"end":785,"spec":false,"focused":false,"pending":false,"nodes":[{"name":"Describe","text":"normal","start":175,"end":308,"spec":false,"focused":false,"pending":false,"nodes":[{"name":"It","text":"normal","start":215,"end":304,"spec":true,"focused":false,"pending":false,"nodes":[{"name":"By","text":"normal","start":250,"end":272,"spec":false,"focused":false,"pending":false,"nodes":[]},{"name":"By","text":"normal","start":276,"end":298,"spec":false,"focused":false,"pending":false,"nodes":[]}]}]},{"name":"Context","text":"normal","start":311,"end":391,"spec":false,"focused":false,"pending":false,"nodes":[{"name":"It","text":"normal","start":350,"end":387,"spec":true,"focused":false,"pending":false,"nodes":[]}]},{"name":"When","text":"normal","start":394,"end":471,"spec":false,"focused":false,"pending":false,"nodes":[{"name":"It","text":"normal","start":430,"end":467,"spec":true,"focused":false,"pending":false,"nodes":[]}]},{"name":"It","text":"normal","start":474,"end":510,"spec":true,"focused":false,"pending":false,"nodes":[]},{"name":"Specify","text":"normal","start":513,"end":554,"spec":true,"focused":false,"pending":false,"nodes":[]},{"name":"Measure","text":"normal","start":557,"end":624,"spec":true,"focused":false,"pending":false,"nodes":[]},{"name":"DescribeTable","text":"normal","start":627,"end":703,"spec":false,"focused":false,"pending":false,"nodes":[{"name":"Entry","text":"normal","start":675,"end":699,"spec":true,"focused":false,"pending":false,"nodes":[]}]},{"name":"DescribeTable","text":"normal","start":706,"end":782,"spec":false,"focused":false,"pending":false,"nodes":[{"name":"Entry","text":"normal","start":754,"end":778,"spec":true,"focused":false,"pending":false,"nodes":[]}]}]}]

ginkgo/outline/_testdata/create_result.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+set -o errexit
+set -o nounset
+
+GINKGO=${GINKGO:-ginkgo}
+
+input=${1:-""}
+for format in "csv" "json"; do
+    set -o xtrace
+    output="$(dirname $input)/$(basename $input).$format"
+    tmp=$(mktemp ginkgo-outline-test.XXX)
+    if "$GINKGO" outline --format="$format" "$input" 1>"$tmp"
+    then mv "$tmp" "$output"
+    else rm "$tmp"
+    set +o xtrace
+    fi
+done