server/web/web_test.go

// Copyright 2023 Woodpecker Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package web

import (
	"net/http"
	"net/http/httptest"
	"os"
	"testing"

	"github.com/gin-gonic/gin"
	"github.com/stretchr/testify/assert"

	"go.woodpecker-ci.org/woodpecker/v3/server"
)

func Test_custom_file_returns_OK_and_empty_content_and_fitting_mimetype(t *testing.T) {
	gin.SetMode(gin.TestMode)

	filesToTest := []struct {
		fileURL       string
		shortMimetype string
	}{
		{
			fileURL:       "/assets/custom.js",
			shortMimetype: "javascript", // using just the short version, since it depends on the go runtime/version
		},
		{
			fileURL:       "/assets/custom.css",
			shortMimetype: "css", // using just the short version, since it depends on the go runtime/version
		},
	}

	for _, f := range filesToTest {
		t.Run(f.fileURL, func(t *testing.T) {
			request, err := http.NewRequest(http.MethodGet, f.fileURL, nil)
			request.RequestURI = f.fileURL // 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())
			assert.Contains(t, rr.Header().Get("Content-Type"), f.shortMimetype)
		})
	}
}

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())
		})
	}
}