api/sunset_test.go at main · dAppCore/api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
// SPDX-License-Identifier: EUPL-1.2

package api_test

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

	"github.com/gin-gonic/gin"

	api "dappco.re/go/core/api"
)

type sunsetStubGroup struct{}

func (sunsetStubGroup) Name() string     { return "legacy" }
func (sunsetStubGroup) BasePath() string { return "/legacy" }
func (sunsetStubGroup) RegisterRoutes(rg *gin.RouterGroup) {
	rg.GET("/status", func(c *gin.Context) {
		c.JSON(http.StatusOK, api.OK("ok"))
	})
}

type sunsetLinkStubGroup struct{}

func (sunsetLinkStubGroup) Name() string     { return "legacy-link" }
func (sunsetLinkStubGroup) BasePath() string { return "/legacy-link" }
func (sunsetLinkStubGroup) RegisterRoutes(rg *gin.RouterGroup) {
	rg.GET("/status", func(c *gin.Context) {
		c.Header("Link", "<https://example.com/docs>; rel=\"help\"")
		c.JSON(http.StatusOK, api.OK("ok"))
	})
}

type sunsetHeaderStubGroup struct{}

func (sunsetHeaderStubGroup) Name() string     { return "legacy-headers" }
func (sunsetHeaderStubGroup) BasePath() string { return "/legacy-headers" }
func (sunsetHeaderStubGroup) RegisterRoutes(rg *gin.RouterGroup) {
	rg.GET("/status", func(c *gin.Context) {
		c.Header("Deprecation", "false")
		c.Header("Sunset", "Wed, 01 Jan 2025 00:00:00 GMT")
		c.Header("X-API-Warn", "Existing warning")
		c.Header("Link", "<https://example.com/docs>; rel=\"help\"")
		c.JSON(http.StatusOK, api.OK("ok"))
	})
}

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

	e, err := api.New(api.WithSunset("2025-06-01", "/api/v2/status"))
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	e.Register(sunsetStubGroup{})

	w := httptest.NewRecorder()
	req, _ := http.NewRequest(http.MethodGet, "/legacy/status", nil)
	e.Handler().ServeHTTP(w, req)

	if w.Code != http.StatusOK {
		t.Fatalf("expected 200, got %d", w.Code)
	}
	if got := w.Header().Get("Deprecation"); got != "true" {
		t.Fatalf("expected Deprecation=true, got %q", got)
	}
	if got := w.Header().Get("Sunset"); got != "Sun, 01 Jun 2025 00:00:00 GMT" {
		t.Fatalf("expected formatted Sunset header, got %q", got)
	}
	if got := w.Header().Get("Link"); got != "</api/v2/status>; rel=\"successor-version\"" {
		t.Fatalf("expected successor Link header, got %q", got)
	}
	if got := w.Header().Get("X-API-Warn"); got != "This endpoint is deprecated and will be removed on 2025-06-01." {
		t.Fatalf("expected deprecation warning, got %q", got)
	}
}

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

	e, err := api.New(api.WithSunset("2025-06-01", "/api/v2/status"))
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	e.Register(sunsetLinkStubGroup{})

	w := httptest.NewRecorder()
	req, _ := http.NewRequest(http.MethodGet, "/legacy-link/status", nil)
	e.Handler().ServeHTTP(w, req)

	if w.Code != http.StatusOK {
		t.Fatalf("expected 200, got %d", w.Code)
	}

	links := w.Header().Values("Link")
	if len(links) != 2 {
		t.Fatalf("expected 2 Link header values, got %v", links)
	}
	if links[0] != "<https://example.com/docs>; rel=\"help\"" {
		t.Fatalf("expected existing Link header to be preserved first, got %q", links[0])
	}
	if links[1] != "</api/v2/status>; rel=\"successor-version\"" {
		t.Fatalf("expected successor Link header to be appended, got %q", links[1])
	}
}

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

	e, err := api.New(api.WithSunset("2025-06-01", "/api/v2/status"))
	if err != nil {
		t.Fatalf("unexpected error: %v", err)
	}
	e.Register(sunsetHeaderStubGroup{})

	w := httptest.NewRecorder()
	req, _ := http.NewRequest(http.MethodGet, "/legacy-headers/status", nil)
	e.Handler().ServeHTTP(w, req)

	if w.Code != http.StatusOK {
		t.Fatalf("expected 200, got %d", w.Code)
	}

	if got := w.Header().Values("Deprecation"); len(got) != 2 {
		t.Fatalf("expected 2 Deprecation header values, got %v", got)
	}
	if got := w.Header().Values("Sunset"); len(got) != 2 {
		t.Fatalf("expected 2 Sunset header values, got %v", got)
	}
	if got := w.Header().Values("X-API-Warn"); len(got) != 2 {
		t.Fatalf("expected 2 X-API-Warn header values, got %v", got)
	}
	if got := w.Header().Values("Link"); len(got) != 2 {
		t.Fatalf("expected 2 Link header values, got %v", got)
	}
}