<!-- Provide a brief summary of your changes --> ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> The following PR adds a new v0.1 API version. The goal is to mark v0.1 as a "freeze" point while keeping v0 as the moving target for new features so integrators can start building on top of something stable(r). Details: * This change is quite simple - we re-register the same handlers twice, once as `v0` and once as `v0.1` * Going forward, we'll keep v0.1 frozen while we add changes either on top of both (non-breaking) or we'll have to branch if breaking changes are necessary * We all acknowledge this is not exactly best-practice, but it gives us a way to gather feedback and allow clients to start integrating with the API without breaking them (**note** this implies a follow up PR that would branch the handlers used in v0.1). * For integrators/clients: please provide your feedback - what works well, what doesn't so we can take this into account going towards GA. ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> ## Breaking Changes <!-- Will users need to update their code or configurations? --> No, this just adds a new API version alongside the existing one. ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] 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 --> Fixes: #649 Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
239 lines
7.8 KiB
Go
239 lines
7.8 KiB
Go
package v0_test
|
|
|
|
import (
|
|
"bytes"
|
|
"crypto/ed25519"
|
|
"crypto/rand"
|
|
"encoding/hex"
|
|
"encoding/json"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
|
|
"github.com/danielgtaylor/huma/v2"
|
|
"github.com/danielgtaylor/huma/v2/adapters/humago"
|
|
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"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestPublishRegistryValidation(t *testing.T) {
|
|
// Create test config with validation ENABLED
|
|
testSeed := make([]byte, ed25519.SeedSize)
|
|
_, err := rand.Read(testSeed)
|
|
require.NoError(t, err)
|
|
testConfig := &config.Config{
|
|
JWTPrivateKey: hex.EncodeToString(testSeed),
|
|
EnableRegistryValidation: true, // Enable validation for this test
|
|
}
|
|
|
|
// Setup fake service
|
|
registryService := service.NewRegistryService(database.NewTestDB(t), testConfig)
|
|
|
|
// Create a new ServeMux and Huma API
|
|
mux := http.NewServeMux()
|
|
api := humago.New(mux, huma.DefaultConfig("Test API", "1.0.0"))
|
|
|
|
// Register the endpoint
|
|
v0.RegisterPublishEndpoint(api, "/v0", registryService, testConfig)
|
|
|
|
t.Run("publish fails with npm registry validation error", func(t *testing.T) {
|
|
publishReq := apiv0.ServerJSON{
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "com.example/test-server-with-npm",
|
|
Description: "A test server with invalid npm package reference",
|
|
Version: "1.0.0",
|
|
Packages: []model.Package{
|
|
{
|
|
RegistryType: model.RegistryTypeNPM,
|
|
Identifier: "nonexistent-npm-package-xyz123",
|
|
Version: "1.0.0",
|
|
Transport: model.Transport{
|
|
Type: model.TransportTypeStdio,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
// Generate valid JWT token with wildcard permission
|
|
claims := auth.JWTClaims{
|
|
AuthMethod: auth.MethodNone,
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "*"},
|
|
},
|
|
}
|
|
token, err := generateTestJWTToken(testConfig, claims)
|
|
require.NoError(t, err)
|
|
|
|
body, err := json.Marshal(publishReq)
|
|
require.NoError(t, err)
|
|
|
|
req := httptest.NewRequest(http.MethodPost, "/v0/publish", bytes.NewReader(body))
|
|
req.Header.Set("Content-Type", "application/json")
|
|
req.Header.Set("Authorization", "Bearer "+token)
|
|
|
|
rr := httptest.NewRecorder()
|
|
mux.ServeHTTP(rr, req)
|
|
|
|
assert.Equal(t, http.StatusBadRequest, rr.Code)
|
|
assert.Contains(t, rr.Body.String(), "registry validation failed")
|
|
})
|
|
|
|
t.Run("publish succeeds with MCPB package (registry validation enabled)", func(t *testing.T) {
|
|
publishReq := apiv0.ServerJSON{
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "com.example/test-server-mcpb-validation",
|
|
Description: "A test server with MCPB package and registry validation enabled",
|
|
Version: "0.0.36",
|
|
Packages: []model.Package{
|
|
{
|
|
RegistryType: model.RegistryTypeMCPB,
|
|
Identifier: "https://github.com/microsoft/playwright-mcp/releases/download/v0.0.36/playwright-mcp-extension-v0.0.36.zip",
|
|
FileSHA256: "fe333e598595000ae021bd27117db32ec69af6987f507ba7a63c90638ff633ce",
|
|
Transport: model.Transport{
|
|
Type: model.TransportTypeStdio,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
// Generate valid JWT token with wildcard permission
|
|
claims := auth.JWTClaims{
|
|
AuthMethod: auth.MethodNone,
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "*"},
|
|
},
|
|
}
|
|
token, err := generateTestJWTToken(testConfig, claims)
|
|
require.NoError(t, err)
|
|
|
|
body, err := json.Marshal(publishReq)
|
|
require.NoError(t, err)
|
|
|
|
req := httptest.NewRequest(http.MethodPost, "/v0/publish", bytes.NewReader(body))
|
|
req.Header.Set("Content-Type", "application/json")
|
|
req.Header.Set("Authorization", "Bearer "+token)
|
|
|
|
rr := httptest.NewRecorder()
|
|
mux.ServeHTTP(rr, req)
|
|
|
|
assert.Equal(t, http.StatusOK, rr.Code)
|
|
|
|
var response apiv0.ServerResponse
|
|
err = json.Unmarshal(rr.Body.Bytes(), &response)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, publishReq.Name, response.Server.Name)
|
|
assert.Equal(t, publishReq.Version, response.Server.Version)
|
|
assert.Len(t, response.Server.Packages, 1)
|
|
assert.Equal(t, model.RegistryTypeMCPB, response.Server.Packages[0].RegistryType)
|
|
})
|
|
|
|
t.Run("publish fails when second package fails npm validation", func(t *testing.T) {
|
|
publishReq := apiv0.ServerJSON{
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "com.example/test-server-multiple-packages",
|
|
Description: "A test server with multiple packages where second fails",
|
|
Version: "1.0.0",
|
|
Packages: []model.Package{
|
|
{
|
|
RegistryType: model.RegistryTypeMCPB,
|
|
Identifier: "https://github.com/microsoft/playwright-mcp/releases/download/v0.0.36/playwright-mcp-extension-v0.0.36.zip",
|
|
FileSHA256: "fe333e598595000ae021bd27117db32ec69af6987f507ba7a63c90638ff633ce",
|
|
Transport: model.Transport{
|
|
Type: model.TransportTypeStdio,
|
|
},
|
|
},
|
|
{
|
|
RegistryType: model.RegistryTypeNPM,
|
|
Identifier: "nonexistent-second-package-abc123",
|
|
Version: "1.0.0",
|
|
Transport: model.Transport{
|
|
Type: model.TransportTypeStdio,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
// Generate valid JWT token with wildcard permission
|
|
claims := auth.JWTClaims{
|
|
AuthMethod: auth.MethodNone,
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "*"},
|
|
},
|
|
}
|
|
token, err := generateTestJWTToken(testConfig, claims)
|
|
require.NoError(t, err)
|
|
|
|
body, err := json.Marshal(publishReq)
|
|
require.NoError(t, err)
|
|
|
|
req := httptest.NewRequest(http.MethodPost, "/v0/publish", bytes.NewReader(body))
|
|
req.Header.Set("Content-Type", "application/json")
|
|
req.Header.Set("Authorization", "Bearer "+token)
|
|
|
|
rr := httptest.NewRecorder()
|
|
mux.ServeHTTP(rr, req)
|
|
|
|
assert.Equal(t, http.StatusBadRequest, rr.Code)
|
|
assert.Contains(t, rr.Body.String(), "registry validation failed for package 1")
|
|
assert.Contains(t, rr.Body.String(), "nonexistent-second-package-abc123")
|
|
})
|
|
|
|
t.Run("publish fails when first package fails validation", func(t *testing.T) {
|
|
publishReq := apiv0.ServerJSON{
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "com.example/test-server-first-package-fails",
|
|
Description: "A test server where first package fails",
|
|
Version: "1.0.0",
|
|
Packages: []model.Package{
|
|
{
|
|
RegistryType: model.RegistryTypeNPM,
|
|
Identifier: "nonexistent-first-package-xyz789",
|
|
Version: "1.0.0",
|
|
Transport: model.Transport{
|
|
Type: model.TransportTypeStdio,
|
|
},
|
|
},
|
|
{
|
|
RegistryType: model.RegistryTypeMCPB,
|
|
Identifier: "https://github.com/microsoft/playwright-mcp/releases/download/v0.0.36/playwright-mcp-extension-v0.0.36.zip",
|
|
FileSHA256: "fe333e598595000ae021bd27117db32ec69af6987f507ba7a63c90638ff633ce",
|
|
Transport: model.Transport{
|
|
Type: model.TransportTypeStdio,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
// Generate valid JWT token with wildcard permission
|
|
claims := auth.JWTClaims{
|
|
AuthMethod: auth.MethodNone,
|
|
Permissions: []auth.Permission{
|
|
{Action: auth.PermissionActionPublish, ResourcePattern: "*"},
|
|
},
|
|
}
|
|
token, err := generateTestJWTToken(testConfig, claims)
|
|
require.NoError(t, err)
|
|
|
|
body, err := json.Marshal(publishReq)
|
|
require.NoError(t, err)
|
|
|
|
req := httptest.NewRequest(http.MethodPost, "/v0/publish", bytes.NewReader(body))
|
|
req.Header.Set("Content-Type", "application/json")
|
|
req.Header.Set("Authorization", "Bearer "+token)
|
|
|
|
rr := httptest.NewRecorder()
|
|
mux.ServeHTTP(rr, req)
|
|
|
|
assert.Equal(t, http.StatusBadRequest, rr.Code)
|
|
assert.Contains(t, rr.Body.String(), "registry validation failed for package 0")
|
|
assert.Contains(t, rr.Body.String(), "nonexistent-first-package-xyz789")
|
|
})
|
|
}
|