woodpecker/server/web/web_test.go
Martin W. Kirst 2c1fc4b500
support custom .JS and .CSS files for custom banner messages (white-labeling) (#1781)
This PR introduces two new server configuration options, for providing a
custom .JS and .CSS file.
These can be used to show custom banner messages, add
environment-dependent signals, or simply a corporate logo.

### Motivation (what problem I try to solve)

I'm operating Woodpecker in multiple k8s clusters for different
environments.
When having multiple browser tabs open, I prefer strong indicators for
each environment.
E.g. a red "PROD" banner, or just a blue "QA" banner.
Also, we sometimes need to have the chance for maintenance, and instead
of broadcasting emails,
I prefer a banner message, stating something like: "Heads-up: there's a
planned downtime, next Friday, blabla...".

Also, I like to have the firm's logo visible, which makes Woodpecker
look more like an integral part of our platform.

### Implementation notes

* Two new config options are introduced ```WOODPECKER_CUSTOM_CSS_FILE```
and ```WOODPECKER_CUSTOM_JS_FILE```
* I've piggy-bagged the existing handler for assets, as it seemed to me
a minimally invasive approach
* the option along with an example is documented
* a simple unit test for the Gin-handler ensures some regression safety
* no extra dependencies are introduced

### Visual example

The documented example will look like this.

![Screenshot 2023-05-27 at 17 00
44](https://github.com/woodpecker-ci/woodpecker/assets/1189394/8940392e-463c-4651-a1eb-f017cd3cd64d)

### Areas of uncertainty 

This is my first contribution to Woodpecker and I tried my best to align
with your conventions.
That said, I found myself uncertain about these things and would be glad
about getting feedback.

* The handler tests are somewhat different than the other ones because I
wanted to keep them simple - I hope that still matches your coding
guidelines
* caching the page sometimes will let the browser not recognize changes
and a user must reload. I'm not fully into the details of how caching is
implemented and neither can judge if it's a real problem. Another pair
of eyes would be good.
2023-07-10 12:46:35 +02:00

70 lines
1.6 KiB
Go

package web
import (
"net/http"
"net/http/httptest"
"os"
"testing"
"github.com/gin-gonic/gin"
"github.com/stretchr/testify/assert"
"github.com/woodpecker-ci/woodpecker/server"
)
func Test_custom_file_returns_OK_and_empty_content(t *testing.T) {
gin.SetMode(gin.TestMode)
customFiles := []string{
"/assets/custom.js",
"/assets/custom.css",
}
for _, f := range customFiles {
t.Run(f, func(t *testing.T) {
request, err := http.NewRequest(http.MethodGet, f, nil)
request.RequestURI = f // additional required for mocking
assert.NoError(t, err)
rr := httptest.NewRecorder()
router, _ := New()
router.ServeHTTP(rr, request)
assert.Equal(t, 200, rr.Code)
assert.Equal(t, []byte(nil), rr.Body.Bytes())
})
}
}
func Test_custom_file_return_actual_content(t *testing.T) {
gin.SetMode(gin.TestMode)
temp, err := os.CreateTemp(os.TempDir(), "data.txt")
assert.NoError(t, err)
_, err = temp.Write([]byte("EXPECTED-DATA"))
assert.NoError(t, err)
err = temp.Close()
assert.NoError(t, err)
server.Config.Server.CustomJsFile = temp.Name()
server.Config.Server.CustomCSSFile = temp.Name()
customRequestedFilesToTest := []string{
"/assets/custom.js",
"/assets/custom.css",
}
for _, f := range customRequestedFilesToTest {
t.Run(f, func(t *testing.T) {
request, err := http.NewRequest(http.MethodGet, f, nil)
request.RequestURI = f // additional required for mocking
assert.NoError(t, err)
rr := httptest.NewRecorder()
router, _ := New()
router.ServeHTTP(rr, request)
assert.Equal(t, 200, rr.Code)
assert.Equal(t, []byte("EXPECTED-DATA"), rr.Body.Bytes())
})
}
}