Add additional tools and tests for notifications

Author: SamMorrowDrums

e2e/README.md

@@ -83,6 +83,18 @@ It is possible to provide `GITHUB_MCP_SERVER_E2E_DEBUG=true` to run the e2e test
 
 One might argue that the lack of visibility into failures for the black box tests also indicates a product need, but this solves for the immediate pain point felt as a maintainer.
 
+## Skipping Global State Mutation Tests
+
+Some tools (such as those that mark all notifications as read) will change the real global state of the authenticated user. For end-to-end (e2e) tests, these tests are **skipped by default** to avoid unwanted side effects.
+
+To opt-in and run these tests (which will modify your global state on GitHub), set the following environment variable:
+
+```
+GITHUB_MCP_SERVER_E2E_MUTATE_GLOBAL_STATE=1
+```
+
+If this variable is not set, tests that would mutate global state will be skipped.
+
 ## Limitations
 
 The current test suite is intentionally very limited in scope. This is because the maintenance costs on e2e tests tend to increase significantly over time. To read about some challenges with GitHub integration tests, see [go-github integration tests README](https://github.com/google/go-github/blob/5b75aa86dba5cf4af2923afa0938774f37fa0a67/test/README.md). We will expand this suite circumspectly!

e2e/e2e_test.go

@@ -24,6 +24,16 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
+// Should be set to opt-in to tests that mutate global state
+const E2EGlobalMutationOptInEnv = "GITHUB_MCP_SERVER_E2E_MUTATE_GLOBAL_STATE"
+
+// skipIfGlobalMutationNotOptedIn skips the test if the opt-in env var is not set
+func skipIfGlobalMutationNotOptedIn(t *testing.T) {
+	if os.Getenv(E2EGlobalMutationOptInEnv) == "" {
+		t.Skipf("Skipping test: set %s=1 to opt-in to global state mutation tests", E2EGlobalMutationOptInEnv)
+	}
+}
+
 var (
 	// Shared variables and sync.Once instances to ensure one-time execution
 	getTokenOnce sync.Once
@@ -61,7 +71,8 @@ func getRESTClient(t *testing.T) *gogithub.Client {
 
 	// Create a new GitHub client with the token
 	ghClient := gogithub.NewClient(nil).WithAuthToken(token)
-	if host := getE2EHost(); host != "https://github.com" {
+
+	if host := getE2EHost(); host != "" && host != "https://github.com" {
 		var err error
 		// Currently this works for GHEC because the API is exposed at the api subdomain and the path prefix
 		// but it would be preferable to extract the host parsing from the main server logic, and use it here.
@@ -1525,3 +1536,303 @@ func TestPullRequestReviewDeletion(t *testing.T) {
 	require.NoError(t, err, "expected to unmarshal text content successfully")
 	require.Len(t, noReviews, 0, "expected to find no reviews")
 }
+
+func ListNotifications(t *testing.T) {
+	t.Parallel()
+	client := setupMCPClient(t)
+	ctx := context.Background()
+
+	request := mcp.CallToolRequest{}
+	request.Params.Name = "list_notifications"
+	request.Params.Arguments = map[string]any{}
+
+	resp, err := client.CallTool(ctx, request)
+	require.NoError(t, err, "expected to call 'list_notifications' tool successfully")
+	require.False(t, resp.IsError, fmt.Sprintf("expected result not to be an error: %+v", resp))
+	require.Len(t, resp.Content, 1, "expected content to have one item")
+
+	var notifications []struct {
+		ID string `json:"id"`
+	}
+	textContent, ok := resp.Content[0].(mcp.TextContent)
+	require.True(t, ok, "expected content to be of type TextContent")
+	err = json.Unmarshal([]byte(textContent.Text), &notifications)
+	require.NoError(t, err, "expected to unmarshal text content successfully")
+}
+
+func ManageNotificationSubscription(t *testing.T) {
+	skipIfGlobalMutationNotOptedIn(t)
+	t.Parallel()
+	client := setupMCPClient(t)
+	ctx := context.Background()
+
+	// List notifications to get a valid notificationID
+	listReq := mcp.CallToolRequest{}
+	listReq.Params.Name = "list_notifications"
+	listReq.Params.Arguments = map[string]any{}
+	resp, err := client.CallTool(ctx, listReq)
+	require.NoError(t, err)
+	require.False(t, resp.IsError)
+
+	textContent, ok := resp.Content[0].(mcp.TextContent)
+	require.True(t, ok)
+	var notifications []struct {
+		ID string `json:"id"`
+	}
+	err = json.Unmarshal([]byte(textContent.Text), &notifications)
+	require.NoError(t, err)
+	require.NotEmpty(t, notifications)
+	if len(notifications) == 0 {
+		t.Skip("No notifications available to test subscription management")
+	}
+	notificationID := notifications[0].ID
+
+	// Ignore notification
+	ignoreReq := mcp.CallToolRequest{}
+	ignoreReq.Params.Name = "manage_notification_subscription"
+	ignoreReq.Params.Arguments = map[string]any{
+		"notificationID": notificationID,
+		"action":         "ignore",
+	}
+	resp, err = client.CallTool(ctx, ignoreReq)
+	require.NoError(t, err)
+	require.False(t, resp.IsError)
+	textContent, ok = resp.Content[0].(mcp.TextContent)
+	require.True(t, ok)
+	require.Contains(t, textContent.Text, "ignored")
+
+	// Validate with REST client
+	restClient := getRESTClient(t)
+	sub, _, err := restClient.Activity.GetThreadSubscription(ctx, notificationID)
+	require.NoError(t, err)
+	require.NotNil(t, sub)
+	require.True(t, sub.GetIgnored(), "expected notification subscription to be ignored")
+
+	// Watch notification
+	watchReq := mcp.CallToolRequest{}
+	watchReq.Params.Name = "manage_notification_subscription"
+	watchReq.Params.Arguments = map[string]any{
+		"notificationID": notificationID,
+		"action":         "watch",
+	}
+	resp, err = client.CallTool(ctx, watchReq)
+	require.NoError(t, err)
+	require.False(t, resp.IsError)
+	textContent, ok = resp.Content[0].(mcp.TextContent)
+	require.True(t, ok)
+	require.Contains(t, textContent.Text, "subscribed")
+
+	// Validate with REST client
+	sub, _, err = restClient.Activity.GetThreadSubscription(ctx, notificationID)
+	require.NoError(t, err)
+	require.NotNil(t, sub)
+	require.False(t, sub.GetIgnored(), "expected notification subscription to not be ignored (watch)")
+	require.True(t, sub.GetSubscribed(), "expected notification subscription to be subscribed")
+
+	// Delete notification subscription
+	deleteReq := mcp.CallToolRequest{}
+	deleteReq.Params.Name = "manage_notification_subscription"
+	deleteReq.Params.Arguments = map[string]any{
+		"notificationID": notificationID,
+		"action":         "delete",
+	}
+	resp, err = client.CallTool(ctx, deleteReq)
+	require.NoError(t, err)
+	require.False(t, resp.IsError)
+	textContent, ok = resp.Content[0].(mcp.TextContent)
+	require.True(t, ok)
+	require.Contains(t, textContent.Text, "deleted")
+
+	// Validate with REST client
+	sub, resp2, err := restClient.Activity.GetThreadSubscription(ctx, notificationID)
+	require.NoError(t, err)
+	require.NotNil(t, sub)
+	require.False(t, sub.GetSubscribed())
+	require.True(t, sub.GetIgnored())
+	require.Equal(t, 204, resp2.StatusCode)
+}
+
+func ManageRepositoryNotificationSubscription(t *testing.T) {
+	skipIfGlobalMutationNotOptedIn(t)
+	t.Parallel()
+	client := setupMCPClient(t)
+	ctx := context.Background()
+
+	// Use a well-known repo for the test (e.g., the user's own repo)
+	owner := "github"
+	repo := "github-mcp-server"
+
+	// Ignore repo notifications
+	ignoreReq := mcp.CallToolRequest{}
+	ignoreReq.Params.Name = "manage_repository_notification_subscription"
+	ignoreReq.Params.Arguments = map[string]any{
+		"owner":  owner,
+		"repo":   repo,
+		"action": "ignore",
+	}
+	resp, err := client.CallTool(ctx, ignoreReq)
+	require.NoError(t, err)
+	require.False(t, resp.IsError)
+	textContent, ok := resp.Content[0].(mcp.TextContent)
+	require.True(t, ok)
+	require.Contains(t, textContent.Text, "ignored")
+
+	// Validate with REST client
+	restClient := getRESTClient(t)
+	sub, _, err := restClient.Activity.GetRepositorySubscription(ctx, owner, repo)
+	require.NoError(t, err)
+	require.NotNil(t, sub)
+	require.True(t, sub.GetIgnored(), "expected repository subscription to be ignored")
+
+	// Watch repo notifications
+	watchReq := mcp.CallToolRequest{}
+	watchReq.Params.Name = "manage_repository_notification_subscription"
+	watchReq.Params.Arguments = map[string]any{
+		"owner":  owner,
+		"repo":   repo,
+		"action": "watch",
+	}
+	resp, err = client.CallTool(ctx, watchReq)
+	require.NoError(t, err)
+	require.False(t, resp.IsError)
+	textContent, ok = resp.Content[0].(mcp.TextContent)
+	require.True(t, ok)
+	require.Contains(t, textContent.Text, "subscribed")
+
+	// Validate with REST client
+	sub, _, err = restClient.Activity.GetRepositorySubscription(ctx, owner, repo)
+	require.NoError(t, err)
+	require.NotNil(t, sub)
+	require.False(t, sub.GetIgnored(), "expected repository subscription to not be ignored (watch)")
+	require.True(t, sub.GetSubscribed(), "expected repository subscription to be subscribed")
+
+	// Delete repo notification subscription
+	deleteReq := mcp.CallToolRequest{}
+	deleteReq.Params.Name = "manage_repository_notification_subscription"
+	deleteReq.Params.Arguments = map[string]any{
+		"owner":  owner,
+		"repo":   repo,
+		"action": "delete",
+	}
+	resp, err = client.CallTool(ctx, deleteReq)
+	require.NoError(t, err)
+	require.False(t, resp.IsError)
+	textContent, ok = resp.Content[0].(mcp.TextContent)
+	require.True(t, ok)
+	require.Contains(t, textContent.Text, "deleted")
+
+	// Validate with REST client
+	sub, resp2, err := restClient.Activity.GetRepositorySubscription(ctx, owner, repo)
+	require.NoError(t, err)
+	require.NotNil(t, sub)
+	require.False(t, sub.GetSubscribed())
+	require.True(t, sub.GetIgnored())
+	require.Equal(t, 204, resp2.StatusCode)
+}
+
+func DismissNotification(t *testing.T) {
+	skipIfGlobalMutationNotOptedIn(t)
+	t.Parallel()
+	client := setupMCPClient(t)
+	ctx := context.Background()
+
+	// List notifications to get a valid threadID
+	listReq := mcp.CallToolRequest{}
+	listReq.Params.Name = "list_notifications"
+	listReq.Params.Arguments = map[string]any{}
+	resp, err := client.CallTool(ctx, listReq)
+	require.NoError(t, err)
+	require.False(t, resp.IsError)
+	textContent, ok := resp.Content[0].(mcp.TextContent)
+	require.True(t, ok)
+	var notifications []struct {
+		ID string `json:"id"`
+	}
+	err = json.Unmarshal([]byte(textContent.Text), &notifications)
+	require.NoError(t, err)
+	if len(notifications) == 0 {
+		t.Skip("No notifications available to test dismissal")
+	}
+	require.NotEmpty(t, notifications)
+	threadID := notifications[0].ID
+
+	// Dismiss notification (mark as read)
+	dismissReq := mcp.CallToolRequest{}
+	dismissReq.Params.Name = "dismiss_notification"
+	dismissReq.Params.Arguments = map[string]any{
+		"threadID": threadID,
+		"state":    "read",
+	}
+	resp, err = client.CallTool(ctx, dismissReq)
+	require.NoError(t, err)
+	require.False(t, resp.IsError)
+	textContent, ok = resp.Content[0].(mcp.TextContent)
+	require.True(t, ok)
+	require.Contains(t, textContent.Text, "read")
+}
+
+func MarkAllNotificationsRead(t *testing.T) {
+	skipIfGlobalMutationNotOptedIn(t)
+	t.Parallel()
+	client := setupMCPClient(t)
+	ctx := context.Background()
+
+	// Limit to notifications updated within the last hour
+	oneHourAgo := nowMinusOneHourRFC3339()
+	markAllReq := mcp.CallToolRequest{}
+	markAllReq.Params.Name = "mark_all_notifications_read"
+	markAllReq.Params.Arguments = map[string]any{
+		"since": oneHourAgo,
+	}
+	resp, err := client.CallTool(ctx, markAllReq)
+	require.NoError(t, err)
+	require.False(t, resp.IsError)
+	textContent, ok := resp.Content[0].(mcp.TextContent)
+	require.True(t, ok)
+	require.Contains(t, textContent.Text, "All notifications marked as read")
+
+}
+
+// nowMinusOneHourRFC3339 returns the RFC3339 timestamp for one hour ago from now (UTC)
+func nowMinusOneHourRFC3339() string {
+	return time.Now().UTC().Add(-1 * time.Hour).Format(time.RFC3339)
+}
+
+func GetNotificationDetails(t *testing.T) {
+	t.Parallel()
+	client := setupMCPClient(t)
+	ctx := context.Background()
+
+	// List notifications to get a valid notificationID
+	listReq := mcp.CallToolRequest{}
+	listReq.Params.Name = "list_notifications"
+	listReq.Params.Arguments = map[string]any{}
+	resp, err := client.CallTool(ctx, listReq)
+	require.NoError(t, err)
+	require.False(t, resp.IsError)
+	textContent, ok := resp.Content[0].(mcp.TextContent)
+	require.True(t, ok)
+	var notifications []struct {
+		ID string `json:"id"`
+	}
+	err = json.Unmarshal([]byte(textContent.Text), &notifications)
+	require.NoError(t, err)
+	require.NotEmpty(t, notifications)
+	if len(notifications) == 0 {
+		t.Skip("No notifications available to test dismissal")
+	}
+	notificationID := notifications[0].ID
+
+	// Get notification details
+	detailsReq := mcp.CallToolRequest{}
+	detailsReq.Params.Name = "get_notification_details"
+	detailsReq.Params.Arguments = map[string]any{
+		"notificationID": notificationID,
+	}
+	resp, err = client.CallTool(ctx, detailsReq)
+	require.NoError(t, err)
+	require.False(t, resp.IsError)
+	textContent, ok = resp.Content[0].(mcp.TextContent)
+	require.True(t, ok)
+	require.Contains(t, textContent.Text, notificationID)
+}