Souin minimal with Traefik plugin support (#18)

* POC minimal version

* Refacto & performance update

* Update tests

* Implement Træfik plugin based on minimal version (#16)
Add vendor for traefik plugin

Author: darkweak

.gitignore

@@ -3,6 +3,5 @@
 docker-compose.yml
 Dockerfile
 /.idea/
-/vendor/
 .DS_Store
 traefik.json

.traefik.yml

@@ -0,0 +1,18 @@
+displayName: Souin
+type: middleware
+import: github.com/darkweak/souin/plugins/traefik
+summary: 'Souin is a powerfull cache system as fast as Varnish but easier to configure'
+
+# Refer to https://github.com/darkweak/Souin/configuration/configuration.sample.yml for full configuration
+testData:
+  default_cache:
+    headers:
+      - Authorization
+    regex:
+      exclude: 'ARegexHere'
+    ttl: 1000
+  urls:
+    'domain.com/':
+      ttl: 1000
+      headers:
+        - Authorization

Dockerfile-dev

@@ -1,25 +1,24 @@
-FROM golang:1.13-alpine AS souin
+FROM golang:1.15-alpine AS souin
 
 RUN apk update && apk upgrade && \
     apk add --no-cache bash git openssh gcc libc-dev
 ENV GOPATH /app
 RUN go get -u \
     golang.org/x/lint/golint \
-    github.com/allegro/bigcache \
     github.com/dgraph-io/ristretto \
     github.com/fsnotify/fsnotify \
-    github.com/go-redis/redis \
-    gopkg.in/yaml.v2
+    gopkg.in/yaml.v3
 
 RUN mkdir -p /app/src/github.com/darkweak/souin
 RUN mkdir -p /ssl
 ADD ./*.go /app/src/github.com/darkweak/souin/
 ADD ./cache /app/src/github.com/darkweak/souin/cache
+ADD ./configuration /app/src/github.com/darkweak/souin/configuration
+ADD ./configuration_types /app/src/github.com/darkweak/souin/configuration_types
+ADD ./default /app/src/github.com/darkweak/souin/default
 ADD ./errors /app/src/github.com/darkweak/souin/errors
+ADD ./helpers /app/src/github.com/darkweak/souin/helpers
 ADD ./providers /app/src/github.com/darkweak/souin/providers
-ADD ./default/server.* /app/src/github.com/darkweak/souin/
-ADD ./configuration/configuration.yml /
-ADD ./configuration /app/src/github.com/darkweak/souin/configuration
 
 WORKDIR /app/src/github.com/darkweak/souin
 

Dockerfile-prod

@@ -1,4 +1,4 @@
-FROM golang:1.13-alpine AS builder
+FROM golang:1.15-alpine AS builder
 
 RUN apk update && apk upgrade && \
     apk add --no-cache bash git openssh gcc libc-dev
@@ -7,22 +7,21 @@ ENV GOOS linux
 ENV GOARCH arm64
 RUN go get -u \
     golang.org/x/lint/golint \
-    github.com/allegro/bigcache \
     github.com/dgraph-io/ristretto \
     github.com/fsnotify/fsnotify \
-    github.com/go-redis/redis \
-    gopkg.in/yaml.v2
+    gopkg.in/yaml.v3
 
 RUN mkdir -p /app/src/github.com/darkweak/cmd
 RUN mkdir -p /app/src/github.com/darkweak/souin
 RUN mkdir -p /ssl
 ADD ./*.go /app/src/github.com/darkweak/souin/
 ADD ./cache /app/src/github.com/darkweak/souin/cache
+ADD ./configuration /app/src/github.com/darkweak/souin/configuration
+ADD ./configuration_types /app/src/github.com/darkweak/souin/configuration_types
+ADD ./default /app/src/github.com/darkweak/souin/default
 ADD ./errors /app/src/github.com/darkweak/souin/errors
+ADD ./helpers /app/src/github.com/darkweak/souin/helpers
 ADD ./providers /app/src/github.com/darkweak/souin/providers
-ADD ./default/server.* /app/src/github.com/darkweak/souin/
-ADD ./configuration/configuration.yml /
-ADD ./configuration/* /app/src/github.com/darkweak/souin/configuration/
 
 WORKDIR /app/src/github.com/darkweak/souin
 
@@ -36,8 +35,11 @@ FROM alpine:latest AS souin
 COPY --from=builder /app/cmd/souin .
 COPY --from=builder /app/src/github.com/darkweak/souin/configuration .
 COPY --from=builder /ssl/ .
-COPY --from=builder /app/src/github.com/darkweak/souin/server.crt .
-COPY --from=builder /app/src/github.com/darkweak/souin/server.key .
+COPY --from=builder /app/src/github.com/darkweak/souin/default .
+RUN mkdir -p configuration
+RUN mv *.yml configuration/
+RUN mkdir -p default
+RUN mv server.* default/
 RUN chmod +x ./souin
 
 CMD ["./souin"]

README.md

@@ -61,23 +61,15 @@ ssl_providers: # The {providers}.json to use
 urls:
   'https:\/\/domain.com\/first-.+': # First regex route configuration
     ttl: 1000 # Override default TTL
-    providers: # Providers list (each item must be in default providers list)
-      - redis
-      - memory
-      - ristretto
   'https:\/\/domain.com\/second-route': # Second regex route configuration
     ttl: 10 # Override default TTL
     headers: # Override default headers
     - Authorization
-    providers: # Providers list (each item must be in default providers list)
-      - memory
   'https?:\/\/mysubdomain\.domain\.com': # Third regex route configuration
     ttl: 50
     headers: # Override default headers
     - Authorization
     - 'Content-Type'
-    providers: # Providers list (each item must be in default providers list)
-      - redis
 ```
 
 |  Key  |  Description  |  Value example  |
@@ -123,9 +115,6 @@ x-networks: &networks
 services:
   traefik:
     image: traefik:v2.0
-    ports:
-      - "81:80" # Note the 81 to 80 port declaration
-      - "444:443" # Note the 444 to 443 port declaration
     command: --providers.docker
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock

cache/providers/abstract.go

@@ -0,0 +1,12 @@
+package providers
+
+import (
+	"github.com/darkweak/souin/configuration_types"
+	"github.com/darkweak/souin/cache/types"
+)
+
+// InitializeProvider allow to generate the providers array according to the configuration
+func InitializeProvider(configuration configuration_types.AbstractConfigurationInterface) types.AbstractProviderInterface {
+	r, _ := RistrettoConnectionFactory(configuration)
+	return r
+}

cache/providers/abstractProvider.go

@@ -0,0 +1,77 @@
+package providers
+
+import (
+	"testing"
+	"github.com/darkweak/souin/configuration"
+	"github.com/darkweak/souin/configuration_types"
+	"github.com/darkweak/souin/errors"
+	"github.com/darkweak/souin/helpers"
+	"regexp"
+	"log"
+)
+
+func MockConfiguration() configuration_types.AbstractConfigurationInterface {
+	var config configuration.Configuration
+	e := config.Parse([]byte(`
+default_cache:
+  headers:
+    - Authorization
+  port:
+    web: 80
+    tls: 443
+  regex:
+    exclude: 'ARegexHere'
+  ttl: 1000
+reverse_proxy_url: 'http://traefik'
+ssl_providers:
+  - traefik
+urls:
+  'domain.com/':
+    ttl: 1000
+    headers:
+      - Authorization
+  'mysubdomain.domain.com':
+    ttl: 50
+    headers:
+      - Authorization
+      - 'Content-Type'
+`))
+	if e != nil {
+		log.Fatal(e)
+	}
+	return &config
+}
+
+func MockInitializeRegexp(configurationInstance configuration_types.AbstractConfigurationInterface) regexp.Regexp {
+	u := ""
+	for k := range configurationInstance.GetUrls() {
+		if "" != u {
+			u += "|"
+		}
+		u += "(" + k + ")"
+	}
+
+	return *regexp.MustCompile(u)
+}
+
+func TestInitializeProvider(t *testing.T) {
+	c := MockConfiguration()
+	p := InitializeProvider(c)
+	err := p.Init()
+	if nil != err {
+		errors.GenerateError(t, "Init shouldn't crash")
+	}
+}
+
+func TestPathnameNotInExcludeRegex(t *testing.T) {
+	config := MockConfiguration()
+	if helpers.PathnameNotInExcludeRegex(config.GetDefaultCache().Regex.Exclude, config) {
+		errors.GenerateError(t, "Pathname should be in regex")
+	}
+	if helpers.PathnameNotInExcludeRegex(config.GetDefaultCache().Regex.Exclude+"/A", config) {
+		errors.GenerateError(t, "Pathname should be in regex")
+	}
+	if !helpers.PathnameNotInExcludeRegex("/BadPath", config) {
+		errors.GenerateError(t, "Pathname shouldn't be in regex")
+	}
+}