(Updated auto-generated PR description from @tadasant / Claude on Feb 22, 2026) ## Motivation and Context Fixes #637 Server lifecycle management (deprecation and yanking) is a standard requirement for package registries. Use cases like rebranding, security vulnerabilities, and end-of-life servers demand the ability to mark servers as deprecated or deleted, with optional messaging to guide consumers toward alternatives. ## Changes ### New API endpoints - **`PATCH /v0/servers/{serverName}/versions/{version}/status`** — Update the lifecycle status of a single server version - **`PATCH /v0/servers/{serverName}/status`** — Update the lifecycle status of all versions of a server in a single transaction Both endpoints accept: ```json { "status": "active|deprecated|deleted", "statusMessage": "Optional message (max 500 chars) explaining the change" } ``` ### New CLI command - **`mcp-publisher status <serverName> [version]`** — Update server lifecycle status from the command line - `--status` (required): `active`, `deprecated`, or `deleted` - `--message`: Optional status message - `--all-versions`: Apply to all versions of the server (replaces the `<version>` argument) ### API response changes `RegistryExtensions` now includes two new fields: - `statusChangedAt` — Timestamp of the last status change - `statusMessage` — Optional free-form message (e.g., deprecation reason, migration guidance) ### List endpoint changes - New `include_deleted` query parameter on `GET /v0/servers` — defaults to `false`, hiding deleted servers from listings - When `updated_since` is provided, `include_deleted` is automatically set to `true` for incremental sync ### Database - Migration `013_add_status_fields.sql`: Adds `status_changed_at` (NOT NULL, initialized from `published_at`) and `status_message` columns to the `servers` table ### Design decisions (from review discussion) - **Dedicated status endpoints** rather than overloading the existing edit endpoint - **Bidirectional status transitions** — all transitions between `active`, `deprecated`, and `deleted` are allowed - **`statusMessage` as free-form text** — no structured `nextName` or `alternativeUrl` fields (per maintainer feedback, to avoid complexity around chaining, trust transfer, etc.) - **Publish permission** grants status change access (not limited to admin/edit) - **Status message auto-cleared** when transitioning back to `active` Good, now I have the full picture. Here's the addendum: ### Consumer-facing API changes The new status fields live inside `_meta["io.modelcontextprotocol.registry/official"]` on every `ServerResponse`. This is the existing `RegistryExtensions` object — two new fields are added alongside the existing ones: **Before:** ```json { "server": { "name": "com.example/my-server", "...": "..." }, "_meta": { "io.modelcontextprotocol.registry/official": { "status": "active", "publishedAt": "2025-06-01T00:00:00Z", "updatedAt": "2025-06-15T00:00:00Z", "isLatest": true } } } ``` **After:** ```json { "server": { "name": "com.example/my-server", "...": "..." }, "_meta": { "io.modelcontextprotocol.registry/official": { "status": "deprecated", "statusChangedAt": "2026-02-01T12:00:00Z", "statusMessage": "Deprecated in favor of com.example/my-server-v2", "publishedAt": "2025-06-01T00:00:00Z", "updatedAt": "2026-02-01T12:00:00Z", "isLatest": true } } } ``` | New field | Type | Present when | |-----------|------|-------------| | `statusChangedAt` | `string` (RFC3339) | Always — initialized to `publishedAt` for existing records | | `statusMessage` | `string` (max 500 chars) | Only when set — `null`/omitted for active servers (auto-cleared on transition to active) | These fields appear on **every endpoint that returns a `ServerResponse`**: `GET /v0/servers`, `GET /v0/servers/{name}`, `GET /v0/servers/{name}/versions/{version}`, and the new PATCH status endpoints. ### List endpoint filtering `GET /v0/servers` gains an `include_deleted` query parameter: | Scenario | Behavior | |----------|----------| | No `include_deleted` param | Deleted servers hidden (default `false`) | | `include_deleted=true` | Deleted servers included in results | | `updated_since` provided | `include_deleted` forced to `true` for incremental sync | ## How Has This Been Tested? - Unit tests for status handler (`status_test.go`) covering status transitions, permission checks, validation errors, and the all-versions endpoint - Unit tests for the CLI command (`status_test.go`) - Integration with existing server/edit handler tests - Database layer tests for the new status update and query methods - Tested locally with `make dev-compose` ## Types of changes - [x] New feature (non-breaking change which adds functionality) ## Checklist - [x] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [x] My code follows the repository's style guidelines - [x] New and existing tests pass locally - [x] I have added appropriate error handling - [x] I have added or updated documentation as needed ## Open items from review - [ ] `include_deleted` silent override: When `updated_since` is provided and `include_deleted=false` is explicitly passed, should return a 400 error rather than silently overriding ([thread](https://github.com/modelcontextprotocol/registry/pull/893#discussion_r2100879360)) — agreed upon but may not yet be implemented
885 lines
29 KiB
Go
885 lines
29 KiB
Go
package v0_test
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"crypto/ed25519"
|
|
"crypto/rand"
|
|
"encoding/hex"
|
|
"encoding/json"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"net/url"
|
|
"testing"
|
|
|
|
"github.com/danielgtaylor/huma/v2"
|
|
"github.com/danielgtaylor/huma/v2/adapters/humago"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
v0 "github.com/modelcontextprotocol/registry/internal/api/handlers/v0"
|
|
"github.com/modelcontextprotocol/registry/internal/auth"
|
|
"github.com/modelcontextprotocol/registry/internal/config"
|
|
"github.com/modelcontextprotocol/registry/internal/database"
|
|
"github.com/modelcontextprotocol/registry/internal/service"
|
|
apiv0 "github.com/modelcontextprotocol/registry/pkg/api/v0"
|
|
"github.com/modelcontextprotocol/registry/pkg/model"
|
|
)
|
|
|
|
func TestUpdateServerStatusEndpoint(t *testing.T) {
|
|
// Create test config
|
|
testSeed := make([]byte, ed25519.SeedSize)
|
|
_, err := rand.Read(testSeed)
|
|
require.NoError(t, err)
|
|
cfg := &config.Config{
|
|
JWTPrivateKey: hex.EncodeToString(testSeed),
|
|
EnableRegistryValidation: false,
|
|
}
|
|
|
|
// Create registry service and test data
|
|
registryService := service.NewRegistryService(database.NewTestDB(t), cfg)
|
|
|
|
// Create test servers for different scenarios
|
|
testServers := map[string]*apiv0.ServerJSON{
|
|
"active": {
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "io.github.testuser/active-server",
|
|
Description: "Server in active status",
|
|
Version: "1.0.0",
|
|
Repository: &model.Repository{
|
|
URL: "https://github.com/testuser/active-server",
|
|
Source: "github",
|
|
ID: "testuser/active-server",
|
|
},
|
|
},
|
|
"deprecated": {
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "io.github.testuser/deprecated-server",
|
|
Description: "Server in deprecated status",
|
|
Version: "1.0.0",
|
|
Repository: &model.Repository{
|
|
URL: "https://github.com/testuser/deprecated-server",
|
|
Source: "github",
|
|
ID: "testuser/deprecated-server",
|
|
},
|
|
},
|
|
"deleted": {
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "io.github.testuser/deleted-server",
|
|
Description: "Server in deleted status",
|
|
Version: "1.0.0",
|
|
Repository: &model.Repository{
|
|
URL: "https://github.com/testuser/deleted-server",
|
|
Source: "github",
|
|
ID: "testuser/deleted-server",
|
|
},
|
|
},
|
|
"other": {
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "io.github.otheruser/other-server",
|
|
Description: "Server owned by another user",
|
|
Version: "1.0.0",
|
|
Repository: &model.Repository{
|
|
URL: "https://github.com/otheruser/other-server",
|
|
Source: "github",
|
|
ID: "otheruser/other-server",
|
|
},
|
|
},
|
|
"multi-version": {
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "io.github.testuser/multi-version-server",
|
|
Description: "Server with multiple versions for testing",
|
|
Version: "1.0.0",
|
|
Repository: &model.Repository{
|
|
URL: "https://github.com/testuser/multi-version-server",
|
|
Source: "github",
|
|
ID: "testuser/multi-version-server",
|
|
},
|
|
},
|
|
}
|
|
|
|
// Create the test servers
|
|
for _, server := range testServers {
|
|
_, err := registryService.CreateServer(context.Background(), server)
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
// Set deprecated server to deprecated status
|
|
_, err = registryService.UpdateServerStatus(context.Background(), testServers["deprecated"].Name, testServers["deprecated"].Version, &service.StatusChangeRequest{
|
|
NewStatus: model.StatusDeprecated,
|
|
})
|
|
require.NoError(t, err)
|
|
|
|
// Set deleted server to deleted status
|
|
_, err = registryService.UpdateServerStatus(context.Background(), testServers["deleted"].Name, testServers["deleted"].Version, &service.StatusChangeRequest{
|
|
NewStatus: model.StatusDeleted,
|
|
})
|
|
require.NoError(t, err)
|
|
|
|
// Add a second version to multi-version server
|
|
multiVersionV2 := &apiv0.ServerJSON{
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "io.github.testuser/multi-version-server",
|
|
Description: "Server with multiple versions for testing",
|
|
Version: "2.0.0",
|
|
Repository: &model.Repository{
|
|
URL: "https://github.com/testuser/multi-version-server",
|
|
Source: "github",
|
|
ID: "testuser/multi-version-server",
|
|
},
|
|
}
|
|
_, err = registryService.CreateServer(context.Background(), multiVersionV2)
|
|
require.NoError(t, err)
|
|
|
|
testCases := []struct {
|
|
name string
|
|
serverName string
|
|
version string
|
|
authClaims *auth.JWTClaims
|
|
authHeader string
|
|
requestBody v0.UpdateServerStatusBody
|
|
expectedStatus int
|
|
expectedError string
|
|
checkResult func(*testing.T, *apiv0.ServerResponse)
|
|
}{
|
|
{
|
|
name: "successful status change from active to deprecated",
|
|
serverName: "io.github.testuser/active-server",
|
|
version: "1.0.0",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deprecated",
|
|
},
|
|
expectedStatus: http.StatusOK,
|
|
checkResult: func(t *testing.T, resp *apiv0.ServerResponse) {
|
|
t.Helper()
|
|
assert.Equal(t, model.StatusDeprecated, resp.Meta.Official.Status)
|
|
},
|
|
},
|
|
{
|
|
name: "successful status change with message",
|
|
serverName: "io.github.testuser/active-server",
|
|
version: "1.0.0",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deleted",
|
|
StatusMessage: strPtr("Security vulnerability discovered"),
|
|
},
|
|
expectedStatus: http.StatusOK,
|
|
checkResult: func(t *testing.T, resp *apiv0.ServerResponse) {
|
|
t.Helper()
|
|
assert.Equal(t, model.StatusDeleted, resp.Meta.Official.Status)
|
|
assert.NotNil(t, resp.Meta.Official.StatusMessage)
|
|
assert.Equal(t, "Security vulnerability discovered", *resp.Meta.Official.StatusMessage)
|
|
},
|
|
},
|
|
{
|
|
name: "successful restore from deleted to active",
|
|
serverName: "io.github.testuser/deleted-server",
|
|
version: "1.0.0",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "active",
|
|
},
|
|
expectedStatus: http.StatusOK,
|
|
checkResult: func(t *testing.T, resp *apiv0.ServerResponse) {
|
|
t.Helper()
|
|
assert.Equal(t, model.StatusActive, resp.Meta.Official.Status)
|
|
// Status message should be cleared when transitioning to active
|
|
assert.Nil(t, resp.Meta.Official.StatusMessage)
|
|
},
|
|
},
|
|
{
|
|
name: "successful undeprecate from deprecated to active",
|
|
serverName: "io.github.testuser/deprecated-server",
|
|
version: "1.0.0",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "active",
|
|
},
|
|
expectedStatus: http.StatusOK,
|
|
checkResult: func(t *testing.T, resp *apiv0.ServerResponse) {
|
|
t.Helper()
|
|
assert.Equal(t, model.StatusActive, resp.Meta.Official.Status)
|
|
},
|
|
},
|
|
{
|
|
name: "missing authorization header",
|
|
serverName: "io.github.testuser/active-server",
|
|
version: "1.0.0",
|
|
authHeader: "",
|
|
requestBody: v0.UpdateServerStatusBody{Status: "deprecated"},
|
|
expectedStatus: http.StatusUnprocessableEntity,
|
|
expectedError: "required header parameter is missing",
|
|
},
|
|
{
|
|
name: "invalid authorization header format",
|
|
serverName: "io.github.testuser/active-server",
|
|
version: "1.0.0",
|
|
authHeader: "InvalidFormat token123",
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deprecated",
|
|
},
|
|
expectedStatus: http.StatusUnauthorized,
|
|
expectedError: "Invalid Authorization header format",
|
|
},
|
|
{
|
|
name: "invalid token",
|
|
serverName: "io.github.testuser/active-server",
|
|
version: "1.0.0",
|
|
authHeader: "Bearer invalid-token",
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deprecated",
|
|
},
|
|
expectedStatus: http.StatusUnauthorized,
|
|
expectedError: "Invalid or expired Registry JWT token",
|
|
},
|
|
{
|
|
name: "permission denied - no publish or edit permissions",
|
|
serverName: "io.github.testuser/active-server",
|
|
version: "1.0.0",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: "read", ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deprecated",
|
|
},
|
|
expectedStatus: http.StatusForbidden,
|
|
expectedError: "You do not have publish or edit permissions for this server",
|
|
},
|
|
{
|
|
name: "successful status change with edit permission only",
|
|
serverName: "io.github.testuser/active-server",
|
|
version: "1.0.0",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionEdit, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deprecated",
|
|
},
|
|
expectedStatus: http.StatusOK,
|
|
checkResult: func(t *testing.T, resp *apiv0.ServerResponse) {
|
|
t.Helper()
|
|
assert.Equal(t, model.StatusDeprecated, resp.Meta.Official.Status)
|
|
},
|
|
},
|
|
{
|
|
name: "successful status change with both publish and edit permissions",
|
|
serverName: "io.github.testuser/active-server",
|
|
version: "1.0.0",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
{Action: auth.PermissionActionEdit, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "active",
|
|
},
|
|
expectedStatus: http.StatusOK,
|
|
checkResult: func(t *testing.T, resp *apiv0.ServerResponse) {
|
|
t.Helper()
|
|
assert.Equal(t, model.StatusActive, resp.Meta.Official.Status)
|
|
},
|
|
},
|
|
{
|
|
name: "permission denied - wrong namespace",
|
|
serverName: "io.github.otheruser/other-server",
|
|
version: "1.0.0",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deprecated",
|
|
},
|
|
expectedStatus: http.StatusForbidden,
|
|
expectedError: "You do not have publish or edit permissions for this server",
|
|
},
|
|
{
|
|
name: "server not found",
|
|
serverName: "io.github.testuser/non-existent",
|
|
version: "1.0.0",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deprecated",
|
|
},
|
|
expectedStatus: http.StatusNotFound,
|
|
expectedError: "Server version not found",
|
|
},
|
|
{
|
|
name: "same status transition allowed when updating statusMessage",
|
|
serverName: "io.github.testuser/deprecated-server",
|
|
version: "1.0.0",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deprecated",
|
|
StatusMessage: strPtr("Updated deprecation message"),
|
|
},
|
|
expectedStatus: http.StatusOK,
|
|
checkResult: func(t *testing.T, resp *apiv0.ServerResponse) {
|
|
t.Helper()
|
|
assert.Equal(t, model.StatusDeprecated, resp.Meta.Official.Status)
|
|
assert.NotNil(t, resp.Meta.Official.StatusMessage)
|
|
assert.Equal(t, "Updated deprecation message", *resp.Meta.Official.StatusMessage)
|
|
},
|
|
},
|
|
{
|
|
name: "status_message rejected when setting status to active",
|
|
serverName: "io.github.testuser/deprecated-server",
|
|
version: "1.0.0",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "active",
|
|
StatusMessage: strPtr("This message should not be allowed"),
|
|
},
|
|
expectedStatus: http.StatusBadRequest,
|
|
expectedError: "status_message cannot be provided when setting status to active",
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
// Create Huma API
|
|
mux := http.NewServeMux()
|
|
api := humago.New(mux, huma.DefaultConfig("Test API", "1.0.0"))
|
|
|
|
// Register status endpoints
|
|
v0.RegisterStatusEndpoints(api, "/v0", registryService, cfg)
|
|
|
|
// Create request body
|
|
requestBody, err := json.Marshal(tc.requestBody)
|
|
require.NoError(t, err)
|
|
|
|
// Create request URL with proper encoding
|
|
encodedServerName := url.PathEscape(tc.serverName)
|
|
encodedVersion := url.PathEscape(tc.version)
|
|
requestURL := "/v0/servers/" + encodedServerName + "/versions/" + encodedVersion + "/status"
|
|
|
|
req := httptest.NewRequest(http.MethodPatch, requestURL, bytes.NewReader(requestBody))
|
|
req.Header.Set("Content-Type", "application/json")
|
|
|
|
// Set authorization header
|
|
if tc.authHeader != "" {
|
|
req.Header.Set("Authorization", tc.authHeader)
|
|
} else if tc.authClaims != nil {
|
|
// Generate valid JWT token
|
|
jwtManager := auth.NewJWTManager(cfg)
|
|
tokenResponse, err := jwtManager.GenerateTokenResponse(context.Background(), *tc.authClaims)
|
|
require.NoError(t, err)
|
|
req.Header.Set("Authorization", "Bearer "+tokenResponse.RegistryToken)
|
|
}
|
|
|
|
// Create response recorder and execute request
|
|
w := httptest.NewRecorder()
|
|
mux.ServeHTTP(w, req)
|
|
|
|
// Check response
|
|
if tc.expectedStatus != w.Code {
|
|
t.Logf("Response body: %s", w.Body.String())
|
|
}
|
|
assert.Equal(t, tc.expectedStatus, w.Code)
|
|
|
|
if tc.expectedError != "" {
|
|
assert.Contains(t, w.Body.String(), tc.expectedError)
|
|
}
|
|
|
|
if tc.expectedStatus == http.StatusOK && tc.checkResult != nil {
|
|
var response apiv0.ServerResponse
|
|
err := json.NewDecoder(w.Body).Decode(&response)
|
|
require.NoError(t, err)
|
|
tc.checkResult(t, &response)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestUpdateServerStatusEndpointSameStatusTransition(t *testing.T) {
|
|
// Create test config
|
|
testSeed := make([]byte, ed25519.SeedSize)
|
|
_, err := rand.Read(testSeed)
|
|
require.NoError(t, err)
|
|
cfg := &config.Config{
|
|
JWTPrivateKey: hex.EncodeToString(testSeed),
|
|
EnableRegistryValidation: false,
|
|
}
|
|
|
|
// Create registry service
|
|
registryService := service.NewRegistryService(database.NewTestDB(t), cfg)
|
|
|
|
// Create an active server
|
|
activeServer := &apiv0.ServerJSON{
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "io.github.testuser/same-status-test",
|
|
Description: "Server for same status transition test",
|
|
Version: "1.0.0",
|
|
}
|
|
_, err = registryService.CreateServer(context.Background(), activeServer)
|
|
require.NoError(t, err)
|
|
|
|
// Create Huma API
|
|
mux := http.NewServeMux()
|
|
api := humago.New(mux, huma.DefaultConfig("Test API", "1.0.0"))
|
|
v0.RegisterStatusEndpoints(api, "/v0", registryService, cfg)
|
|
|
|
// Try to transition from active to active (should fail)
|
|
requestBody := v0.UpdateServerStatusBody{
|
|
Status: "active",
|
|
}
|
|
bodyBytes, err := json.Marshal(requestBody)
|
|
require.NoError(t, err)
|
|
|
|
encodedName := url.PathEscape(activeServer.Name)
|
|
requestURL := "/v0/servers/" + encodedName + "/versions/1.0.0/status"
|
|
|
|
req := httptest.NewRequest(http.MethodPatch, requestURL, bytes.NewReader(bodyBytes))
|
|
req.Header.Set("Content-Type", "application/json")
|
|
|
|
// Generate admin token
|
|
jwtManager := auth.NewJWTManager(cfg)
|
|
tokenResponse, err := jwtManager.GenerateTokenResponse(context.Background(), auth.JWTClaims{
|
|
AuthMethod: auth.MethodNone,
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "*"},
|
|
},
|
|
})
|
|
require.NoError(t, err)
|
|
req.Header.Set("Authorization", "Bearer "+tokenResponse.RegistryToken)
|
|
|
|
w := httptest.NewRecorder()
|
|
mux.ServeHTTP(w, req)
|
|
|
|
assert.Equal(t, http.StatusBadRequest, w.Code)
|
|
assert.Contains(t, w.Body.String(), "No changes to apply: status and message are already set to the provided values")
|
|
}
|
|
|
|
func TestUpdateServerStatusEndpointURLEncoding(t *testing.T) {
|
|
// Create test config
|
|
testSeed := make([]byte, ed25519.SeedSize)
|
|
_, err := rand.Read(testSeed)
|
|
require.NoError(t, err)
|
|
cfg := &config.Config{
|
|
JWTPrivateKey: hex.EncodeToString(testSeed),
|
|
EnableRegistryValidation: false,
|
|
}
|
|
|
|
// Create registry service
|
|
registryService := service.NewRegistryService(database.NewTestDB(t), cfg)
|
|
|
|
// Create a server with build metadata version
|
|
buildMetadataServer := &apiv0.ServerJSON{
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "io.github.testuser/build-metadata-server",
|
|
Description: "Server with build metadata version",
|
|
Version: "1.0.0+20130313144700",
|
|
}
|
|
_, err = registryService.CreateServer(context.Background(), buildMetadataServer)
|
|
require.NoError(t, err)
|
|
|
|
// Create Huma API
|
|
mux := http.NewServeMux()
|
|
api := humago.New(mux, huma.DefaultConfig("Test API", "1.0.0"))
|
|
v0.RegisterStatusEndpoints(api, "/v0", registryService, cfg)
|
|
|
|
// Update status with URL-encoded version
|
|
requestBody := v0.UpdateServerStatusBody{
|
|
Status: "deprecated",
|
|
StatusMessage: strPtr("Testing URL encoding"),
|
|
}
|
|
bodyBytes, err := json.Marshal(requestBody)
|
|
require.NoError(t, err)
|
|
|
|
encodedName := url.PathEscape(buildMetadataServer.Name)
|
|
encodedVersion := url.PathEscape(buildMetadataServer.Version)
|
|
requestURL := "/v0/servers/" + encodedName + "/versions/" + encodedVersion + "/status"
|
|
|
|
req := httptest.NewRequest(http.MethodPatch, requestURL, bytes.NewReader(bodyBytes))
|
|
req.Header.Set("Content-Type", "application/json")
|
|
|
|
// Generate admin token
|
|
jwtManager := auth.NewJWTManager(cfg)
|
|
tokenResponse, err := jwtManager.GenerateTokenResponse(context.Background(), auth.JWTClaims{
|
|
AuthMethod: auth.MethodNone,
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "*"},
|
|
},
|
|
})
|
|
require.NoError(t, err)
|
|
req.Header.Set("Authorization", "Bearer "+tokenResponse.RegistryToken)
|
|
|
|
w := httptest.NewRecorder()
|
|
mux.ServeHTTP(w, req)
|
|
|
|
assert.Equal(t, http.StatusOK, w.Code)
|
|
|
|
var response apiv0.ServerResponse
|
|
err = json.NewDecoder(w.Body).Decode(&response)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, model.StatusDeprecated, response.Meta.Official.Status)
|
|
assert.Equal(t, "1.0.0+20130313144700", response.Server.Version)
|
|
}
|
|
|
|
func TestUpdateAllVersionsStatusEndpoint(t *testing.T) {
|
|
// Create test config
|
|
testSeed := make([]byte, ed25519.SeedSize)
|
|
_, err := rand.Read(testSeed)
|
|
require.NoError(t, err)
|
|
cfg := &config.Config{
|
|
JWTPrivateKey: hex.EncodeToString(testSeed),
|
|
EnableRegistryValidation: false,
|
|
}
|
|
|
|
// Create registry service and test data
|
|
registryService := service.NewRegistryService(database.NewTestDB(t), cfg)
|
|
|
|
// Create a server with multiple versions
|
|
multiVersionServer := &apiv0.ServerJSON{
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "io.github.testuser/multi-version-server",
|
|
Description: "Server with multiple versions",
|
|
Version: "1.0.0",
|
|
Repository: &model.Repository{
|
|
URL: "https://github.com/testuser/multi-version-server",
|
|
Source: "github",
|
|
ID: "testuser/multi-version-server",
|
|
},
|
|
}
|
|
_, err = registryService.CreateServer(context.Background(), multiVersionServer)
|
|
require.NoError(t, err)
|
|
|
|
// Add more versions
|
|
multiVersionServer.Version = "1.1.0"
|
|
_, err = registryService.CreateServer(context.Background(), multiVersionServer)
|
|
require.NoError(t, err)
|
|
|
|
multiVersionServer.Version = "2.0.0"
|
|
_, err = registryService.CreateServer(context.Background(), multiVersionServer)
|
|
require.NoError(t, err)
|
|
|
|
// Create other user's server
|
|
otherServer := &apiv0.ServerJSON{
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "io.github.otheruser/other-server",
|
|
Description: "Server owned by another user",
|
|
Version: "1.0.0",
|
|
Repository: &model.Repository{
|
|
URL: "https://github.com/otheruser/other-server",
|
|
Source: "github",
|
|
ID: "otheruser/other-server",
|
|
},
|
|
}
|
|
_, err = registryService.CreateServer(context.Background(), otherServer)
|
|
require.NoError(t, err)
|
|
|
|
testCases := []struct {
|
|
name string
|
|
serverName string
|
|
authClaims *auth.JWTClaims
|
|
authHeader string
|
|
requestBody v0.UpdateServerStatusBody
|
|
expectedStatus int
|
|
expectedError string
|
|
checkResult func(*testing.T, *v0.UpdateAllVersionsStatusResponse)
|
|
}{
|
|
{
|
|
name: "successful deprecation of all versions",
|
|
serverName: "io.github.testuser/multi-version-server",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deprecated",
|
|
StatusMessage: strPtr("This server is deprecated"),
|
|
},
|
|
expectedStatus: http.StatusOK,
|
|
checkResult: func(t *testing.T, resp *v0.UpdateAllVersionsStatusResponse) {
|
|
t.Helper()
|
|
assert.Equal(t, 3, resp.UpdatedCount)
|
|
assert.Len(t, resp.Servers, 3)
|
|
for _, server := range resp.Servers {
|
|
assert.Equal(t, model.StatusDeprecated, server.Meta.Official.Status)
|
|
assert.NotNil(t, server.Meta.Official.StatusMessage)
|
|
assert.Equal(t, "This server is deprecated", *server.Meta.Official.StatusMessage)
|
|
}
|
|
},
|
|
},
|
|
{
|
|
name: "successful delete of all versions",
|
|
serverName: "io.github.testuser/multi-version-server",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deleted",
|
|
StatusMessage: strPtr("Security issue discovered"),
|
|
},
|
|
expectedStatus: http.StatusOK,
|
|
checkResult: func(t *testing.T, resp *v0.UpdateAllVersionsStatusResponse) {
|
|
t.Helper()
|
|
assert.Equal(t, 3, resp.UpdatedCount)
|
|
for _, server := range resp.Servers {
|
|
assert.Equal(t, model.StatusDeleted, server.Meta.Official.Status)
|
|
assert.NotNil(t, server.Meta.Official.StatusMessage)
|
|
assert.Equal(t, "Security issue discovered", *server.Meta.Official.StatusMessage)
|
|
}
|
|
},
|
|
},
|
|
{
|
|
name: "successful reactivation of all versions",
|
|
serverName: "io.github.testuser/multi-version-server",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "active",
|
|
},
|
|
expectedStatus: http.StatusOK,
|
|
checkResult: func(t *testing.T, resp *v0.UpdateAllVersionsStatusResponse) {
|
|
t.Helper()
|
|
assert.Equal(t, 3, resp.UpdatedCount)
|
|
for _, server := range resp.Servers {
|
|
assert.Equal(t, model.StatusActive, server.Meta.Official.Status)
|
|
// Status message should be cleared when transitioning to active
|
|
assert.Nil(t, server.Meta.Official.StatusMessage)
|
|
}
|
|
},
|
|
},
|
|
{
|
|
name: "missing authorization header",
|
|
serverName: "io.github.testuser/multi-version-server",
|
|
authHeader: "",
|
|
requestBody: v0.UpdateServerStatusBody{Status: "deprecated"},
|
|
expectedStatus: http.StatusUnprocessableEntity,
|
|
expectedError: "required header parameter is missing",
|
|
},
|
|
{
|
|
name: "invalid authorization header format",
|
|
serverName: "io.github.testuser/multi-version-server",
|
|
authHeader: "InvalidFormat token123",
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deprecated",
|
|
},
|
|
expectedStatus: http.StatusUnauthorized,
|
|
expectedError: "Invalid Authorization header format",
|
|
},
|
|
{
|
|
name: "permission denied - no publish or edit permissions",
|
|
serverName: "io.github.testuser/multi-version-server",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: "read", ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deprecated",
|
|
},
|
|
expectedStatus: http.StatusForbidden,
|
|
expectedError: "You do not have publish or edit permissions for this server",
|
|
},
|
|
{
|
|
name: "successful status change with edit permission only",
|
|
serverName: "io.github.testuser/multi-version-server",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionEdit, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deprecated",
|
|
},
|
|
expectedStatus: http.StatusOK,
|
|
checkResult: func(t *testing.T, resp *v0.UpdateAllVersionsStatusResponse) {
|
|
t.Helper()
|
|
assert.Equal(t, 3, resp.UpdatedCount)
|
|
for _, server := range resp.Servers {
|
|
assert.Equal(t, model.StatusDeprecated, server.Meta.Official.Status)
|
|
}
|
|
},
|
|
},
|
|
{
|
|
name: "successful status change with both publish and edit permissions",
|
|
serverName: "io.github.testuser/multi-version-server",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
{Action: auth.PermissionActionEdit, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "active",
|
|
},
|
|
expectedStatus: http.StatusOK,
|
|
checkResult: func(t *testing.T, resp *v0.UpdateAllVersionsStatusResponse) {
|
|
t.Helper()
|
|
assert.Equal(t, 3, resp.UpdatedCount)
|
|
for _, server := range resp.Servers {
|
|
assert.Equal(t, model.StatusActive, server.Meta.Official.Status)
|
|
}
|
|
},
|
|
},
|
|
{
|
|
name: "bulk no-op when all versions already have target status and message",
|
|
serverName: "io.github.testuser/multi-version-server",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "active",
|
|
},
|
|
expectedStatus: http.StatusBadRequest,
|
|
expectedError: "No changes to apply: all versions already have the requested status and message",
|
|
},
|
|
{
|
|
name: "server not found",
|
|
serverName: "io.github.testuser/non-existent",
|
|
authClaims: &auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "testuser",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"},
|
|
},
|
|
},
|
|
requestBody: v0.UpdateServerStatusBody{
|
|
Status: "deprecated",
|
|
},
|
|
expectedStatus: http.StatusNotFound,
|
|
expectedError: "Server not found",
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
// Create Huma API
|
|
mux := http.NewServeMux()
|
|
api := humago.New(mux, huma.DefaultConfig("Test API", "1.0.0"))
|
|
|
|
// Register all-versions status endpoints
|
|
v0.RegisterAllVersionsStatusEndpoints(api, "/v0", registryService, cfg)
|
|
|
|
// Create request body
|
|
requestBody, err := json.Marshal(tc.requestBody)
|
|
require.NoError(t, err)
|
|
|
|
// Create request URL with proper encoding
|
|
encodedServerName := url.PathEscape(tc.serverName)
|
|
requestURL := "/v0/servers/" + encodedServerName + "/status"
|
|
|
|
req := httptest.NewRequest(http.MethodPatch, requestURL, bytes.NewReader(requestBody))
|
|
req.Header.Set("Content-Type", "application/json")
|
|
|
|
// Set authorization header
|
|
if tc.authHeader != "" {
|
|
req.Header.Set("Authorization", tc.authHeader)
|
|
} else if tc.authClaims != nil {
|
|
// Generate valid JWT token
|
|
jwtManager := auth.NewJWTManager(cfg)
|
|
tokenResponse, err := jwtManager.GenerateTokenResponse(context.Background(), *tc.authClaims)
|
|
require.NoError(t, err)
|
|
req.Header.Set("Authorization", "Bearer "+tokenResponse.RegistryToken)
|
|
}
|
|
|
|
// Create response recorder and execute request
|
|
w := httptest.NewRecorder()
|
|
mux.ServeHTTP(w, req)
|
|
|
|
// Check response
|
|
if tc.expectedStatus != w.Code {
|
|
t.Logf("Response body: %s", w.Body.String())
|
|
}
|
|
assert.Equal(t, tc.expectedStatus, w.Code)
|
|
|
|
if tc.expectedError != "" {
|
|
assert.Contains(t, w.Body.String(), tc.expectedError)
|
|
}
|
|
|
|
if tc.expectedStatus == http.StatusOK && tc.checkResult != nil {
|
|
var response v0.UpdateAllVersionsStatusResponse
|
|
err := json.NewDecoder(w.Body).Decode(&response)
|
|
require.NoError(t, err)
|
|
tc.checkResult(t, &response)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// strPtr is a helper function to create a pointer to a string
|
|
func strPtr(s string) *string {
|
|
return &s
|
|
}
|