099a2d702e<!-- Provide a brief summary of your changes --> ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> The following PR eliminates duplicate struct definitions by migrating the publisher tool to use canonical types from pkg/model, creating a single source of truth across the codebase. The publisher tool previously had its own copies of structs that were duplicated, ie. ServerJSON, Package, Repository, VersionDetail, EnvironmentVariable, RuntimeArgument and a few others which was not optimal **Changes in the PR:** - Refactored the structs to single canonical types located at pkg/model - Refactor the implementation to use/build canonical structures directly - Remove all duplicate definitions (5 structs eliminated) - Publisher now uses model.ServerJSON, model.Package, model.Repository, etc. - Renamed some of the structs to better reflect their use case, i.e. ServerJSON instead of ServerDetail - Fixes an issue where the Remote property was missing from the previous publisher copy of the Server **Benefits:** - Single source of truth - Schema changes in one place - Type safety - Compiler catches mismatches - Enhanced validation - Field constraints and bson tags - Zero breaking changes - Same CLI interface and JSON output - Future-proof - New canonical fields automatically available Supersedes: #217 and #240 ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> Locally ## Breaking Changes <!-- Will users need to update their code or configurations? --> No ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [ ] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [ ] My code follows the repository's style guidelines - [ ] New and existing tests pass locally - [ ] I have added appropriate error handling - [ ] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions --> --------- Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
349 lines
12 KiB
Go
349 lines
12 KiB
Go
package v0_test
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"errors"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
|
|
"github.com/danielgtaylor/huma/v2"
|
|
"github.com/danielgtaylor/huma/v2/adapters/humago"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/mock"
|
|
|
|
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"
|
|
apiv1 "github.com/modelcontextprotocol/registry/pkg/api/v1"
|
|
"github.com/modelcontextprotocol/registry/pkg/model"
|
|
)
|
|
|
|
func TestEditServerEndpoint(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
serverID string
|
|
authHeader string
|
|
requestBody interface{}
|
|
setupMocks func(*MockRegistryService)
|
|
expectedStatus int
|
|
expectedError string
|
|
}{
|
|
{
|
|
name: "successful edit with valid token and permissions",
|
|
serverID: "550e8400-e29b-41d4-a716-446655440001",
|
|
authHeader: func() string {
|
|
cfg := &config.Config{JWTPrivateKey: "bb2c6b424005acd5df47a9e2c87f446def86dd740c888ea3efb825b23f7ef47c"}
|
|
token, _ := generateTestJWTToken(cfg, auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "domdomegg",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionEdit, ResourcePattern: "io.github.domdomegg/*"},
|
|
},
|
|
})
|
|
return "Bearer " + token
|
|
}(),
|
|
requestBody: apiv1.PublishRequest{
|
|
Server: model.ServerJSON{
|
|
Name: "io.github.domdomegg/test-server",
|
|
Description: "Updated test server",
|
|
Status: model.StatusDeprecated,
|
|
Repository: model.Repository{
|
|
URL: "https://github.com/domdomegg/test-server",
|
|
Source: "github",
|
|
ID: "domdomegg/test-server",
|
|
},
|
|
VersionDetail: model.VersionDetail{
|
|
Version: "1.0.1",
|
|
},
|
|
},
|
|
},
|
|
setupMocks: func(registry *MockRegistryService) {
|
|
// Current server (not deleted)
|
|
currentServer := &apiv1.ServerRecord{
|
|
Server: model.ServerJSON{
|
|
Name: "io.github.domdomegg/test-server",
|
|
Description: "Original server",
|
|
Status: model.StatusActive,
|
|
},
|
|
}
|
|
registry.On("GetByID", "550e8400-e29b-41d4-a716-446655440001").Return(currentServer, nil)
|
|
|
|
expectedResponse := &apiv1.ServerRecord{
|
|
Server: model.ServerJSON{
|
|
Name: "io.github.domdomegg/test-server",
|
|
Description: "Updated test server",
|
|
Status: model.StatusDeprecated,
|
|
},
|
|
}
|
|
registry.On("EditServer", "550e8400-e29b-41d4-a716-446655440001", mock.AnythingOfType("v1.PublishRequest")).Return(expectedResponse, nil)
|
|
},
|
|
expectedStatus: http.StatusOK,
|
|
},
|
|
{
|
|
name: "missing authorization header",
|
|
serverID: "550e8400-e29b-41d4-a716-446655440001",
|
|
authHeader: "",
|
|
requestBody: apiv1.PublishRequest{},
|
|
setupMocks: func(_ *MockRegistryService) {},
|
|
expectedStatus: 422,
|
|
expectedError: "required header parameter is missing",
|
|
},
|
|
{
|
|
name: "invalid authorization header format",
|
|
serverID: "550e8400-e29b-41d4-a716-446655440001",
|
|
authHeader: "InvalidFormat token123",
|
|
requestBody: apiv1.PublishRequest{},
|
|
setupMocks: func(_ *MockRegistryService) {},
|
|
expectedStatus: http.StatusUnauthorized,
|
|
expectedError: "Unauthorized",
|
|
},
|
|
{
|
|
name: "invalid token",
|
|
serverID: "550e8400-e29b-41d4-a716-446655440001",
|
|
authHeader: "Bearer invalid-token",
|
|
requestBody: apiv1.PublishRequest{},
|
|
setupMocks: func(_ *MockRegistryService) {},
|
|
expectedStatus: http.StatusUnauthorized,
|
|
expectedError: "Unauthorized",
|
|
},
|
|
{
|
|
name: "permission denied - no edit permissions",
|
|
serverID: "550e8400-e29b-41d4-a716-446655440001",
|
|
authHeader: func() string {
|
|
cfg := &config.Config{JWTPrivateKey: "bb2c6b424005acd5df47a9e2c87f446def86dd740c888ea3efb825b23f7ef47c"}
|
|
token, _ := generateTestJWTToken(cfg, auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "domdomegg",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.domdomegg/*"},
|
|
},
|
|
})
|
|
return "Bearer " + token
|
|
}(),
|
|
requestBody: apiv1.PublishRequest{
|
|
Server: model.ServerJSON{
|
|
Name: "io.github.domdomegg/test-server",
|
|
Description: "Updated test server",
|
|
},
|
|
},
|
|
setupMocks: func(registry *MockRegistryService) {
|
|
// Need to mock GetByID since we check permissions against existing server name
|
|
currentServer := &apiv1.ServerRecord{
|
|
Server: model.ServerJSON{
|
|
Name: "io.github.domdomegg/test-server",
|
|
Description: "Original server",
|
|
Status: model.StatusActive,
|
|
},
|
|
}
|
|
registry.On("GetByID", "550e8400-e29b-41d4-a716-446655440001").Return(currentServer, nil)
|
|
},
|
|
expectedStatus: http.StatusForbidden,
|
|
expectedError: "Forbidden",
|
|
},
|
|
{
|
|
name: "permission denied - wrong resource",
|
|
serverID: "550e8400-e29b-41d4-a716-446655440001",
|
|
authHeader: func() string {
|
|
cfg := &config.Config{JWTPrivateKey: "bb2c6b424005acd5df47a9e2c87f446def86dd740c888ea3efb825b23f7ef47c"}
|
|
token, _ := generateTestJWTToken(cfg, auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "domdomegg",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionEdit, ResourcePattern: "io.github.domdomegg/*"},
|
|
},
|
|
})
|
|
return "Bearer " + token
|
|
}(),
|
|
requestBody: apiv1.PublishRequest{
|
|
Server: model.ServerJSON{
|
|
Name: "io.github.other/test-server",
|
|
Description: "Updated test server",
|
|
},
|
|
},
|
|
setupMocks: func(registry *MockRegistryService) {
|
|
// Need to mock GetByID since we check permissions against existing server name
|
|
// This test case shows a different scenario: existing server is "other" but user only has perms for "domdomegg"
|
|
currentServer := &apiv1.ServerRecord{
|
|
Server: model.ServerJSON{
|
|
Name: "io.github.other/test-server",
|
|
Description: "Original server",
|
|
Status: model.StatusActive,
|
|
},
|
|
}
|
|
registry.On("GetByID", "550e8400-e29b-41d4-a716-446655440001").Return(currentServer, nil)
|
|
},
|
|
expectedStatus: http.StatusForbidden,
|
|
expectedError: "Forbidden",
|
|
},
|
|
{
|
|
name: "server not found",
|
|
serverID: "550e8400-e29b-41d4-a716-446655440001",
|
|
authHeader: func() string {
|
|
cfg := &config.Config{JWTPrivateKey: "bb2c6b424005acd5df47a9e2c87f446def86dd740c888ea3efb825b23f7ef47c"}
|
|
token, _ := generateTestJWTToken(cfg, auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "domdomegg",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionEdit, ResourcePattern: "io.github.domdomegg/*"},
|
|
},
|
|
})
|
|
return "Bearer " + token
|
|
}(),
|
|
requestBody: apiv1.PublishRequest{
|
|
Server: model.ServerJSON{
|
|
Name: "io.github.domdomegg/test-server",
|
|
Description: "Updated test server",
|
|
},
|
|
},
|
|
setupMocks: func(registry *MockRegistryService) {
|
|
registry.On("GetByID", "550e8400-e29b-41d4-a716-446655440001").Return(nil, database.ErrNotFound)
|
|
},
|
|
expectedStatus: http.StatusNotFound,
|
|
expectedError: "Not Found",
|
|
},
|
|
{
|
|
name: "service error",
|
|
serverID: "550e8400-e29b-41d4-a716-446655440001",
|
|
authHeader: func() string {
|
|
cfg := &config.Config{JWTPrivateKey: "bb2c6b424005acd5df47a9e2c87f446def86dd740c888ea3efb825b23f7ef47c"}
|
|
token, _ := generateTestJWTToken(cfg, auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "domdomegg",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionEdit, ResourcePattern: "*"},
|
|
},
|
|
})
|
|
return "Bearer " + token
|
|
}(),
|
|
requestBody: apiv1.PublishRequest{
|
|
Server: model.ServerJSON{
|
|
Name: "io.github.domdomegg/test-server",
|
|
Description: "Updated test server",
|
|
},
|
|
},
|
|
setupMocks: func(registry *MockRegistryService) {
|
|
// Current server (not deleted)
|
|
currentServer := &apiv1.ServerRecord{
|
|
Server: model.ServerJSON{
|
|
Name: "io.github.domdomegg/test-server",
|
|
Description: "Original server",
|
|
Status: model.StatusActive,
|
|
},
|
|
}
|
|
registry.On("GetByID", "550e8400-e29b-41d4-a716-446655440001").Return(currentServer, nil)
|
|
registry.On("EditServer", "550e8400-e29b-41d4-a716-446655440001", mock.AnythingOfType("v1.PublishRequest")).Return(nil, errors.New("database error"))
|
|
},
|
|
expectedStatus: http.StatusBadRequest,
|
|
expectedError: "Bad Request",
|
|
},
|
|
{
|
|
name: "invalid request body",
|
|
serverID: "550e8400-e29b-41d4-a716-446655440001",
|
|
authHeader: func() string {
|
|
cfg := &config.Config{JWTPrivateKey: "bb2c6b424005acd5df47a9e2c87f446def86dd740c888ea3efb825b23f7ef47c"}
|
|
token, _ := generateTestJWTToken(cfg, auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "domdomegg",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionEdit, ResourcePattern: "*"},
|
|
},
|
|
})
|
|
return "Bearer " + token
|
|
}(),
|
|
requestBody: "invalid json",
|
|
setupMocks: func(_ *MockRegistryService) {},
|
|
expectedStatus: http.StatusBadRequest,
|
|
expectedError: "Bad Request",
|
|
},
|
|
{
|
|
name: "cannot undelete server",
|
|
serverID: "550e8400-e29b-41d4-a716-446655440001",
|
|
authHeader: func() string {
|
|
cfg := &config.Config{JWTPrivateKey: "bb2c6b424005acd5df47a9e2c87f446def86dd740c888ea3efb825b23f7ef47c"}
|
|
token, _ := generateTestJWTToken(cfg, auth.JWTClaims{
|
|
AuthMethod: auth.MethodGitHubAT,
|
|
AuthMethodSubject: "domdomegg",
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionEdit, ResourcePattern: "*"},
|
|
},
|
|
})
|
|
return "Bearer " + token
|
|
}(),
|
|
requestBody: apiv1.PublishRequest{
|
|
Server: model.ServerJSON{
|
|
Name: "io.github.domdomegg/test-server",
|
|
Description: "Trying to undelete server",
|
|
Status: model.StatusActive,
|
|
},
|
|
},
|
|
setupMocks: func(registry *MockRegistryService) {
|
|
// Current server is deleted
|
|
currentServer := &apiv1.ServerRecord{
|
|
Server: model.ServerJSON{
|
|
Name: "io.github.domdomegg/test-server",
|
|
Description: "Original server",
|
|
Status: model.StatusDeleted,
|
|
},
|
|
}
|
|
registry.On("GetByID", "550e8400-e29b-41d4-a716-446655440001").Return(currentServer, nil)
|
|
},
|
|
expectedStatus: http.StatusBadRequest,
|
|
expectedError: "Cannot change status of deleted server",
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
// Create mock registry
|
|
mockRegistry := new(MockRegistryService)
|
|
tc.setupMocks(mockRegistry)
|
|
|
|
// Create Huma API
|
|
mux := http.NewServeMux()
|
|
humaConfig := huma.DefaultConfig("Test API", "1.0.0")
|
|
api := humago.New(mux, humaConfig)
|
|
|
|
// Register edit endpoints
|
|
cfg := &config.Config{
|
|
JWTPrivateKey: "bb2c6b424005acd5df47a9e2c87f446def86dd740c888ea3efb825b23f7ef47c",
|
|
}
|
|
v0.RegisterEditEndpoints(api, mockRegistry, cfg)
|
|
|
|
// Create request body
|
|
var requestBody []byte
|
|
var err error
|
|
if str, ok := tc.requestBody.(string); ok {
|
|
requestBody = []byte(str)
|
|
} else {
|
|
requestBody, err = json.Marshal(tc.requestBody)
|
|
assert.NoError(t, err)
|
|
}
|
|
|
|
// Create request
|
|
req := httptest.NewRequest(http.MethodPut, "/v0/servers/"+tc.serverID, bytes.NewReader(requestBody))
|
|
req.Header.Set("Content-Type", "application/json")
|
|
if tc.authHeader != "" {
|
|
req.Header.Set("Authorization", tc.authHeader)
|
|
}
|
|
|
|
// Create response recorder
|
|
w := httptest.NewRecorder()
|
|
|
|
// Call the endpoint
|
|
mux.ServeHTTP(w, req)
|
|
|
|
// Check status code
|
|
assert.Equal(t, tc.expectedStatus, w.Code)
|
|
|
|
// Check error message if expected
|
|
if tc.expectedError != "" {
|
|
assert.Contains(t, w.Body.String(), tc.expectedError)
|
|
}
|
|
|
|
mockRegistry.AssertExpectations(t)
|
|
})
|
|
}
|
|
}
|