Merge pull request #71 from vdemeester/56-simple-file-panic

Add a regression test for #56 :)

circle.yml

@@ -6,6 +6,7 @@ machine:
   environment:
     REPO: $CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME
     DOCKER_HOST: tcp://172.17.42.1:2375
+    VERSION: v1.0.alpha.$CIRCLE_BUILD_NUM
 
 dependencies:
   pre:
@@ -27,8 +28,8 @@ deployment:
   hub:
     branch: master
     commands:
-      - ghr -t $GITHUB_TOKEN -u $CIRCLE_PROJECT_USERNAME -r $CIRCLE_PROJECT_REPONAME --prerelease v1.0.alpha.$CIRCLE_BUILD_NUM dist/
+      - ghr -t $GITHUB_TOKEN -u $CIRCLE_PROJECT_USERNAME -r $CIRCLE_PROJECT_REPONAME --prerelease ${VERSION} dist/
       - docker login -e $DOCKER_EMAIL -u $DOCKER_USER -p $DOCKER_PASS
       - docker push ${REPO,,}:latest
-      - docker tag ${REPO,,}:latest ${REPO,,}:v1.0.alpha.$CIRCLE_BUILD_NUM
-      - docker push ${REPO,,}:v1.0.alpha.$CIRCLE_BUILD_NUM
+      - docker tag ${REPO,,}:latest ${REPO,,}:${VERSION}
+      - docker push ${REPO,,}:${VERSION}

configuration.go

@@ -3,23 +3,25 @@ package main
 import (
 	"errors"
 	"strings"
+	"time"
 )
 
 type GlobalConfiguration struct {
-	Port              string
-	GraceTimeOut      int64
-	AccessLogsFile    string
-	TraefikLogsFile   string
-	CertFile, KeyFile string
-	LogLevel          string
-	Docker            *DockerProvider
-	File              *FileProvider
-	Web               *WebProvider
-	Marathon          *MarathonProvider
-	Consul            *ConsulProvider
-	Etcd              *EtcdProvider
-	Zookeeper         *ZookepperProvider
-	Boltdb            *BoltDbProvider
+	Port                      string
+	GraceTimeOut              int64
+	AccessLogsFile            string
+	TraefikLogsFile           string
+	CertFile, KeyFile         string
+	LogLevel                  string
+	ProvidersThrottleDuration time.Duration
+	Docker                    *DockerProvider
+	File                      *FileProvider
+	Web                       *WebProvider
+	Marathon                  *MarathonProvider
+	Consul                    *ConsulProvider
+	Etcd                      *EtcdProvider
+	Zookeeper                 *ZookepperProvider
+	Boltdb                    *BoltDbProvider
 }
 
 func NewGlobalConfiguration() *GlobalConfiguration {
@@ -28,6 +30,7 @@ func NewGlobalConfiguration() *GlobalConfiguration {
 	globalConfiguration.Port = ":80"
 	globalConfiguration.GraceTimeOut = 10
 	globalConfiguration.LogLevel = "ERROR"
+	globalConfiguration.ProvidersThrottleDuration = time.Duration(2 * time.Second)
 
 	return globalConfiguration
 }

docs/index.md

@@ -107,6 +107,16 @@ For example:
 #
 # CertFile = "traefik.crt"
 # KeyFile = "traefik.key"
+
+# Backends throttle duration: minimum duration between 2 events from providers
+# before applying a new configuration. It avoids unnecessary reloads if multiples events
+# are sent in a short amount of time.
+#
+# Optional
+# Default: "2s"
+#
+# ProvidersThrottleDuration = "5s"
+
 ```
 
 

integration/file_test.go

@@ -15,7 +15,23 @@ func (s *FileSuite) TestSimpleConfiguration(c *check.C) {
 	c.Assert(err, checker.IsNil)
 
 	time.Sleep(500 * time.Millisecond)
-	// TODO validate : run on 80
+	resp, err := http.Get("http://127.0.0.1/")
+
+	// Expected a 404 as we did not configure anything
+	c.Assert(err, checker.IsNil)
+	c.Assert(resp.StatusCode, checker.Equals, 404)
+
+	killErr := cmd.Process.Kill()
+	c.Assert(killErr, checker.IsNil)
+}
+
+// #56 regression test, make sure it does not fail
+func (s *FileSuite) TestSimpleConfigurationNoPanic(c *check.C) {
+	cmd := exec.Command(traefikBinary, "fixtures/file/56-simple-panic.toml")
+	err := cmd.Start()
+	c.Assert(err, checker.IsNil)
+
+	time.Sleep(500 * time.Millisecond)
 	resp, err := http.Get("http://127.0.0.1/")
 
 	// Expected a 404 as we did not configure anything

integration/fixtures/file/56-simple-panic.toml

@@ -0,0 +1,11 @@
+# Reverse proxy port
+#
+# Optional
+# Default: ":80"
+#
+# port = ":80"
+#
+# LogLevel
+logLevel = "DEBUG"
+
+[file]

integration/marathon_test.go

@@ -10,7 +10,7 @@ import (
 )
 
 func (s *MarathonSuite) TestSimpleConfiguration(c *check.C) {
-	cmd := exec.Command(traefikBinary, "fixtures/consul/simple.toml")
+	cmd := exec.Command(traefikBinary, "fixtures/marathon/simple.toml")
 	err := cmd.Start()
 	c.Assert(err, checker.IsNil)
 
@@ -18,7 +18,7 @@ func (s *MarathonSuite) TestSimpleConfiguration(c *check.C) {
 	// TODO validate : run on 80
 	resp, err := http.Get("http://127.0.0.1/")
 
-	// Expected a 404 as we did not comfigure anything
+	// Expected a 404 as we did not configure anything
 	c.Assert(err, checker.IsNil)
 	c.Assert(resp.StatusCode, checker.Equals, 404)
 

script/binary

@@ -8,6 +8,13 @@ fi
 
 rm -f dist/traefik
 
-# Build binaries
-CGO_ENABLED=0 go build -a -installsuffix nocgo -o dist/traefik .
+if [ -z "$VERSION" ]; then
+    VERSION=$(git rev-parse HEAD)
+fi
 
+if [ -z "$DATE" ]; then
+    DATE=$(date -u '+%Y-%m-%d_%I:%M:%S%p')
+fi
+
+# Build binaries
+CGO_ENABLED=0 go build -ldflags "-X main.Version=$VERSION -X main.BuildDate=$DATE" -a -installsuffix nocgo -o dist/traefik .

script/crossbinary

@@ -20,10 +20,17 @@ else
     OS_ARCH_ARG=($2)
 fi
 
+if [ -z "$VERSION" ]; then
+    VERSION=$(git rev-parse HEAD)
+fi
+
+if [ -z "$DATE" ]; then
+    DATE=$(date -u '+%Y-%m-%d_%I:%M:%S%p')
+fi
+
 # Get rid of existing binaries
 rm -f dist/traefik_*
 
 # Build binaries
-gox "${OS_PLATFORM_ARG[@]}" "${OS_ARCH_ARG[@]}" \
+gox -ldflags "-X main.Version=$VERSION -X main.BuildDate=$DATE" "${OS_PLATFORM_ARG[@]}" "${OS_ARCH_ARG[@]}" \
     -output="dist/traefik_{{.OS}}-{{.Arch}}"
-

traefik.go

@@ -29,7 +29,10 @@ import (
 )
 
 var (
+	Version               = ""
+	BuildDate             = ""
 	globalConfigFile      = kingpin.Arg("conf", "Main configration file.").Default("traefik.toml").String()
+	version               = kingpin.Flag("version", "Get Version.").Short('v').Bool()
 	currentConfigurations = make(configs)
 	metrics               = stats.New()
 	oxyLogger             = &OxyLogger{}
@@ -49,12 +52,15 @@ type configs map[string]*Configuration
 
 func main() {
 	runtime.GOMAXPROCS(runtime.NumCPU())
+	kingpin.Version(Version + " built on the " + BuildDate)
 	kingpin.Parse()
 	fmtlog.SetFlags(fmtlog.Lshortfile | fmtlog.LstdFlags)
 	var srv *manners.GracefulServer
 	var configurationRouter *mux.Router
 	var configurationChan = make(chan configMessage, 10)
 	defer close(configurationChan)
+	var configurationChanValidated = make(chan configMessage, 10)
+	defer close(configurationChanValidated)
 	var sigs = make(chan os.Signal, 1)
 	defer close(sigs)
 	var stopChan = make(chan bool)
@@ -92,10 +98,32 @@ func main() {
 
 	// listen new configurations from providers
 	go func() {
-
+		lastReceivedConfiguration := time.Unix(0, 0)
+		lastConfigs := make(map[string]*configMessage)
 		for {
 			configMsg := <-configurationChan
 			log.Infof("Configuration receveived from provider %s: %#v", configMsg.providerName, configMsg.configuration)
+			lastConfigs[configMsg.providerName] = &configMsg
+			if time.Now().After(lastReceivedConfiguration.Add(time.Duration(globalConfiguration.ProvidersThrottleDuration))) {
+				log.Infof("Last %s config received more than %s, OK", configMsg.providerName, globalConfiguration.ProvidersThrottleDuration)
+				// last config received more than n s ago
+				configurationChanValidated <- configMsg
+			} else {
+				log.Infof("Last %s config received less than %s, waiting...", configMsg.providerName, globalConfiguration.ProvidersThrottleDuration)
+				go func() {
+					<-time.After(globalConfiguration.ProvidersThrottleDuration)
+					if time.Now().After(lastReceivedConfiguration.Add(time.Duration(globalConfiguration.ProvidersThrottleDuration))) {
+						log.Infof("Waited for %s config, OK", configMsg.providerName)
+						configurationChanValidated <- *lastConfigs[configMsg.providerName]
+					}
+				}()
+			}
+			lastReceivedConfiguration = time.Now()
+		}
+	}()
+	go func() {
+		for {
+			configMsg := <-configurationChanValidated
 			if configMsg.configuration == nil {
 				log.Info("Skipping empty configuration")
 			} else if reflect.DeepEqual(currentConfigurations[configMsg.providerName], configMsg.configuration) {
@@ -116,7 +144,7 @@ func main() {
 					newsrv := prepareServer(configurationRouter, globalConfiguration, oldServer, loggerMiddleware, metrics)
 					go startServer(newsrv, globalConfiguration)
 					srv = newsrv
-					time.Sleep(2 * time.Second)
+					time.Sleep(1 * time.Second)
 					if oldServer != nil {
 						log.Info("Stopping old server")
 						oldServer.Close()

traefik.sample.toml

@@ -44,6 +44,16 @@
 # CertFile = "traefik.crt"
 # KeyFile = "traefik.key"
 
+# Backends throttle duration: minimum duration between 2 events from providers
+# before applying a new configuration. It avoids unnecessary reloads if multiples events
+# are sent in a short amount of time.
+#
+# Optional
+# Default: "2s"
+#
+# ProvidersThrottleDuration = "5s"
+
+
 ################################################################
 # Web configuration backend
 ################################################################