Feat/reverse proxy (#21)

* doc: update config example

* chore: update go mod version

* chore: update ci

* doc: update doc

* feat: handle reverse proxy

* chore: update golang lint ci config

* chore: add cSpell words

* chore: update ci

* chore: force exec of ci

* chore: try to fix ginkgo

* chore: try new things for ci

* chore: update go.mod

* chore: revert back changed-file ci

.github/workflows/ginkgo.yml

@@ -8,15 +8,19 @@ on:
       - master
   pull_request:
 
+permissions:
+  contents: read
+
 jobs:
   mod:
     runs-on: ubuntu-latest
     name: Check modules
     steps:
 
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v4
         with:
-          go-version: 1.17
+          go-version: '1.20'
+          cache: false
 
       - name: Checkout
         uses: actions/checkout@v3
@@ -25,7 +29,7 @@ jobs:
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@v35.9.2
+        uses: tj-actions/changed-files@v37.0.2
         with:
           files: |
             go.*
@@ -42,9 +46,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v4
         with:
-          go-version: '1.19'
+          go-version: '1.20'
 
       - name: Checkout
         uses: actions/checkout@v3
@@ -53,7 +57,7 @@ jobs:
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@v35.9.2
+        uses: tj-actions/changed-files@v37.0.2
         with:
           files: |
             go.*

.github/workflows/golangci-lint.yml

@@ -9,28 +9,30 @@ on:
 
 permissions:
   contents: read
+
 jobs:
   golangci:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v4
         with:
-          go-version: 1.17
+          go-version: '1.20'
+          cache: false
       - uses: actions/checkout@v3
         with:
           fetch-depth: 2
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@v35.9.2
+        uses: tj-actions/changed-files@v37.0.2
         with:
           files: |
             go.*
             **/*.go
 
       - name: golangci-lint
         if: steps.changed-files.outputs.any_changed == 'true'
-        uses: golangci/golangci-lint-action@v3.4.0
+        uses: golangci/golangci-lint-action@v3
         with:
-          version: v1.52.2
+          version: v1.53.3

.github/workflows/goreleaser.yml

@@ -15,7 +15,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.17
+          go-version: 1.20
       - name: Compile the source
         uses: goreleaser/goreleaser-action@v2
         with:

.golangci.yml

@@ -24,7 +24,7 @@ linters:
     - gocognit
     - gofmt
     - goimports
-    - depguard
+    # - depguard
     - misspell
     - lll
     - unparam

.vscode/settings.json

@@ -3,9 +3,11 @@
         "asciicheck",
         "bbolt",
         "bodyclose",
+        "Bogdan",
         "dblk",
         "deadcode",
         "depguard",
+        "Dono",
         "dupl",
         "errcheck",
         "Errorf",
@@ -49,6 +51,7 @@
         "logutils",
         "mapstructure",
         "mitchellh",
+        "mockgen",
         "nakedret",
         "nestif",
         "newfiles",
@@ -59,7 +62,9 @@
         "onsi",
         "prealloc",
         "renameio",
+        "Roadmap",
         "robustio",
+        "Rosu",
         "scopelint",
         "sirupsen",
         "Slowloris",
@@ -73,6 +78,7 @@
         "titledb",
         "Titlekey",
         "tmpl",
+        "traefik",
         "typecheck",
         "Uauth",
         "unconvert",

README.md

@@ -77,6 +77,11 @@ Dead simple, thanks to Golang!
 
 If you change an interface (or add a new one), do not forget to execute `./update_mocks.sh` to generate up-to-date mocks for tests.
 
+Do not forget to install `mockgen` first:
+```sh
+go install github.com/golang/mock/mockgen@v1.6.0
+```
+
 ## What to launch tests?
 
 You can run `ginkgo -r` for one shot or `ginkgo watch -r` during development.  

config.example.yaml

@@ -14,6 +14,10 @@ protocol: https
 # This is used as title when trying to visit the shop with a non switch device
 name: TinShop
 
+# Tells if we are using a reverse proxy if front of tinshop [optional]
+# This is used to rewrite correct url to download games when reverse proxy used
+reverseProxy: false
+
 # All debug flags will be stored here
 debug:
   # Display more information when connecting to nfs share

config/config.go

@@ -41,6 +41,7 @@ type File struct {
 	ShopProtocol     string                             `mapstructure:"protocol"`
 	ShopPort         int                                `mapstructure:"port"`
 	Debug            debug                              `mapstructure:"debug"`
+	Proxy            bool                               `mapstructure:"reverseProxy"`
 	AllSources       repository.ConfigSources           `mapstructure:"sources"`
 	Name             string                             `mapstructure:"name"`
 	Security         security                           `mapstructure:"security"`
@@ -94,6 +95,7 @@ func (cfg *File) configChange() {
 	cfg.ShopHost = newConfig.ShopHost
 	cfg.ShopProtocol = newConfig.ShopProtocol
 	cfg.ShopPort = newConfig.ShopPort
+	cfg.Proxy = newConfig.Proxy
 	cfg.Debug = newConfig.Debug
 	cfg.AllSources = newConfig.AllSources
 	cfg.Name = newConfig.Name
@@ -148,11 +150,15 @@ func ComputeDefaultValues(config repository.Config) repository.Config {
 	} else {
 		rootShop += config.Host()
 	}
-	if config.Port() == 0 {
-		rootShop += ":3000"
-	} else if !(config.Port() == 443 && config.Protocol() == "https") && !(config.Port() == 80 && config.Protocol() == "http") {
-		rootShop += ":" + strconv.Itoa(config.Port())
+
+	if !config.ReverseProxy() {
+		if config.Port() == 0 {
+			rootShop += ":3000"
+		} else if !(config.Port() == 443 && config.Protocol() == "https") && !(config.Port() == 80 && config.Protocol() == "http") {
+			rootShop += ":" + strconv.Itoa(config.Port())
+		}
 	}
+	log.Println((rootShop))
 	config.SetRootShop(rootShop)
 
 	config.SetShopTemplateData(repository.ShopTemplate{
@@ -181,6 +187,9 @@ func (cfg *File) SetRootShop(root string) {
 func (cfg *File) RootShop() string {
 	return cfg.rootShop
 }
+func (cfg *File) ReverseProxy() bool {
+	return cfg.Proxy
+}
 
 // Protocol returns the protocol scheme (http or https)
 func (cfg *File) Protocol() string {

config/config_test.go

@@ -64,6 +64,10 @@ var _ = Describe("Config", func() {
 					Port().
 					Return(0).
 					AnyTimes()
+				myMockConfig.EXPECT().
+					ReverseProxy().
+					Return(false).
+					AnyTimes()
 				config.ComputeDefaultValues(myMockConfig)
 
 				Expect(testRootShop).To(Equal("http://tinshop.example.com:3000"))
@@ -85,6 +89,10 @@ var _ = Describe("Config", func() {
 					Port().
 					Return(443).
 					AnyTimes()
+				myMockConfig.EXPECT().
+					ReverseProxy().
+					Return(false).
+					AnyTimes()
 				config.ComputeDefaultValues(myMockConfig)
 
 				Expect(testRootShop).To(Equal("https://tinshop.example.com"))
@@ -106,6 +114,10 @@ var _ = Describe("Config", func() {
 					Port().
 					Return(80).
 					AnyTimes()
+				myMockConfig.EXPECT().
+					ReverseProxy().
+					Return(false).
+					AnyTimes()
 				config.ComputeDefaultValues(myMockConfig)
 
 				Expect(testRootShop).To(Equal("http://tinshop.example.com"))
@@ -127,10 +139,39 @@ var _ = Describe("Config", func() {
 					Port().
 					Return(8080).
 					AnyTimes()
+				myMockConfig.EXPECT().
+					ReverseProxy().
+					Return(false).
+					AnyTimes()
 				config.ComputeDefaultValues(myMockConfig)
 
 				Expect(testRootShop).To(Equal("http://tinshop.example.com:8080"))
 			})
+			It("Should not set port if reverse proxy", func() {
+				var testRootShop string
+				myMockConfig.EXPECT().
+					Protocol().
+					Return("http").
+					AnyTimes()
+				myMockConfig.EXPECT().
+					SetRootShop(gomock.Any()).
+					Return().
+					Do(func(rootShop string) {
+						testRootShop = rootShop
+					}).
+					AnyTimes()
+				myMockConfig.EXPECT().
+					Port().
+					Return(0).
+					AnyTimes()
+				myMockConfig.EXPECT().
+					ReverseProxy().
+					Return(true).
+					AnyTimes()
+				config.ComputeDefaultValues(myMockConfig)
+
+				Expect(testRootShop).To(Equal("http://tinshop.example.com"))
+			})
 		})
 	})
 	Context("Security for Blacklist/Whitelist tests", func() {
@@ -279,6 +320,21 @@ var _ = Describe("Config", func() {
 			Expect(myConfig.Port()).To(Equal(12345))
 		})
 	})
+	Describe("ReverseProxy", func() {
+		var myConfig config.File
+
+		BeforeEach(func() {
+			myConfig = config.File{}
+		})
+
+		It("Test with empty object", func() {
+			Expect(myConfig.ReverseProxy()).To(BeFalse())
+		})
+		It("Test with a value", func() {
+			myConfig.Proxy = true
+			Expect(myConfig.ReverseProxy()).To(BeTrue())
+		})
+	})
 	Describe("ShopTitle", func() {
 		var myConfig config.File
 

go.mod

@@ -1,37 +1,40 @@
 module github.com/DblK/tinshop
 
-go 1.17
+go 1.20
 
 require (
-	github.com/dustin/go-humanize v1.0.0
-	github.com/fsnotify/fsnotify v1.5.1
+	github.com/dustin/go-humanize v1.0.1
+	github.com/fsnotify/fsnotify v1.6.0
 	github.com/golang/mock v1.6.0
 	github.com/gorilla/mux v1.8.0
-	github.com/onsi/ginkgo/v2 v2.0.0
-	github.com/onsi/gomega v1.17.0
-	github.com/spf13/viper v1.10.1
+	github.com/onsi/ginkgo/v2 v2.11.0
+	github.com/onsi/gomega v1.27.8
+	github.com/spf13/viper v1.16.0
 	github.com/vmware/go-nfs-client v0.0.0-20190605212624-d43b92724c1b
-	go.etcd.io/bbolt v1.3.6
+	go.etcd.io/bbolt v1.3.7
 	gopkg.in/fsnotify.v1 v1.4.7
 )
 
 require (
+	github.com/go-logr/logr v1.2.4 // indirect
+	github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 // indirect
+	github.com/google/go-cmp v0.5.9 // indirect
+	github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
-	github.com/kr/pretty v0.2.0 // indirect
-	github.com/magiconair/properties v1.8.5 // indirect
-	github.com/mitchellh/mapstructure v1.4.3 // indirect
-	github.com/onsi/ginkgo v1.16.5 // indirect
-	github.com/pelletier/go-toml v1.9.4 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/pelletier/go-toml/v2 v2.0.8 // indirect
 	github.com/rasky/go-xdr v0.0.0-20170124162913-1a41d1a06c93 // indirect
-	github.com/spf13/afero v1.6.0 // indirect
-	github.com/spf13/cast v1.4.1 // indirect
+	github.com/spf13/afero v1.9.5 // indirect
+	github.com/spf13/cast v1.5.1 // indirect
 	github.com/spf13/jwalterweatherman v1.1.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/subosito/gotenv v1.2.0 // indirect
-	golang.org/x/net v0.7.0 // indirect
-	golang.org/x/sys v0.5.0 // indirect
-	golang.org/x/text v0.7.0 // indirect
+	github.com/subosito/gotenv v1.4.2 // indirect
+	golang.org/x/net v0.10.0 // indirect
+	golang.org/x/sys v0.9.0 // indirect
+	golang.org/x/text v0.9.0 // indirect
+	golang.org/x/tools v0.9.3 // indirect
 	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
-	gopkg.in/ini.v1 v1.66.2 // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )