echo/middleware/log_test.go

package middleware

import (
	"bytes"
	"errors"
	"net/http"
	"testing"

	"github.com/labstack/echo"
	"github.com/labstack/echo/test"
	"github.com/labstack/gommon/log"
	"github.com/stretchr/testify/assert"
)

func TestLog(t *testing.T) {
	// Note: Just for the test coverage, not a real test.
	e := echo.New()
	req := test.NewRequest(echo.GET, "/", nil)
	rec := test.NewResponseRecorder()
	c := echo.NewContext(req, rec, e)
	h := func(c echo.Context) error {
		return c.String(http.StatusOK, "test")
	}
	mw := Log()(h)

	// Status 2xx
	mw(c)

	// Status 3xx
	rec = test.NewResponseRecorder()
	c = echo.NewContext(req, rec, e)
	h = func(c echo.Context) error {
		return c.String(http.StatusTemporaryRedirect, "test")
	}
	mw(c)

	// Status 4xx
	rec = test.NewResponseRecorder()
	c = echo.NewContext(req, rec, e)
	h = func(c echo.Context) error {
		return c.String(http.StatusNotFound, "test")
	}
	mw(c)

	// Status 5xx with empty path
	req = test.NewRequest(echo.GET, "", nil)
	rec = test.NewResponseRecorder()
	c = echo.NewContext(req, rec, e)
	h = func(c echo.Context) error {
		return errors.New("error")
	}
	mw(c)
}

func TestLogIPAddress(t *testing.T) {
	e := echo.New()
	req := test.NewRequest(echo.GET, "/", nil)
	rec := test.NewResponseRecorder()
	c := echo.NewContext(req, rec, e)
	buf := new(bytes.Buffer)
	e.Logger().(*log.Logger).SetOutput(buf)
	ip := "127.0.0.1"
	h := func(c echo.Context) error {
		return c.String(http.StatusOK, "test")
	}
	mw := Log()(h)

	// With X-Real-IP
	req.Header().Add(echo.XRealIP, ip)
	mw(c)
	assert.Contains(t, buf.String(), ip)

	// With X-Forwarded-For
	buf.Reset()
	req.Header().Del(echo.XRealIP)
	req.Header().Add(echo.XForwardedFor, ip)
	mw(c)
	assert.Contains(t, buf.String(), ip)

	// with req.RemoteAddr
	buf.Reset()
	mw(c)
	assert.Contains(t, buf.String(), ip)
}