HandlerのAnnouncementのテスト実装 by hikaru-0602 · Pull Request #5 · fun-dotto/admin-bff-api

hikaru-0602 · 2026-02-06T08:15:47Z

やったこと

RepositoryのAnnouncementのモック作成
HandlerのAnnouncementのテスト実装

Copilot

Pull request overview

This PR implements comprehensive test coverage for the Announcement handler and creates a mock repository for testing purposes. The implementation adds handler tests for all CRUD operations (List, Detail, Create, Update, Delete) with authentication verification, along with a mock repository that returns predictable test data.

Changes:

Created a mock implementation of AnnouncementRepository for testing
Added comprehensive handler tests for all announcement endpoints with table-driven test patterns
Added testify library as a test dependency

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 19 comments.

File	Description
internal/repository/announcement_mock.go	Mock repository implementation that returns predictable test data for all CRUD operations
internal/handler/announcement_test.go	Comprehensive test suite for announcement handlers covering basic functionality and authentication
go.mod	Added testify testing library dependency and its transitive dependencies

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

internal/handler/announcement_test.go

kantacky

Copilotのレビュー直せば良さそう
403のケースとか、カスタムクレームの組み合わせのケースとか

kantacky

間違えてApproveしちゃった

… for exact error message

Enhanced the TestAnnouncementsV1List function to include a new test case for handling requests with a developer claim. Updated the test structure to accommodate the additional claim and ensured proper validation of the response for this scenario.

Enhanced the TestAnnouncementsV1Update function by adding a new test case that verifies the response when a token with non-admin/developer claims is used. This ensures proper handling of insufficient permissions and improves overall test coverage for authentication scenarios.

Enhanced the TestAnnouncementsV1Create function by adding a new test case that verifies the ability to create announcements with a developer claim. Updated the test structure to include the new claim and ensured proper validation of the response for this scenario.

Updated the TestAnnouncementsV1Delete function to include a new test case for handling deletion requests with a developer claim. Adjusted the expected status code to reflect the correct response for successful deletions and modified the test setup to accommodate different claim types. Additionally, changed the handler to use AbortWithStatus for consistency in response handling.

Updated the TestAnnouncementsV1List and TestAnnouncementsV1Update functions to enhance test clarity and error handling. Introduced the require package for better error assertions and adjusted variable formatting for consistency. This improves overall test reliability and readability.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

internal/repository/announcement_mock.go

internal/handler/announcement_test.go

Copilot · 2026-02-08T06:25:37Z

internal/handler/announcement_test.go

+				assert.Equal(t, "application/json; charset=utf-8", w.Header().Get("Content-Type"))
+			},


Content-Type を完全一致で application/json; charset=utf-8 に固定すると、Gin の挙動変更やミドルウェアによる差分でテストが壊れやすいです。mime.ParseMediaType で media type 部分だけを確認するか、strings.HasPrefix(contentType, "application/json") のように JSON であることを検証する形がより堅牢です。

internal/handler/announcement_test.go

internal/handler/announcement.go

…e response

hikaru-0602 · 2026-02-08T08:12:06Z

Copilotの指摘を修正し，全テストが通ることを確認しています

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

internal/handler/announcement_test.go

masaya-osuga · 2026-02-08T11:53:23Z

新しくきたCopilotの指摘を直したらいいと思います

kantacky · 2026-02-10T02:04:31Z

@hikaru-0602
Copilotのコメント解決してる？してたら、Resolveボタン押してほしい
あと、コンフリクトしちゃったので、その修正もお願いします 🙇

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

hikaru-0602 · 2026-02-10T02:09:14Z

@kantacky
ごめん忘れてた．
コンフリクトも修正した

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

internal/handler/announcement_test.go

kantacky · 2026-02-10T02:12:42Z

@hikaru-0602
Copilotのコメント、まだ残ってそう？
あとCI落ちた...

…on validation Updated TestAnnouncementsV1List, TestAnnouncementsV1Detail, and TestAnnouncementsV1Delete to include custom claims for testing 403 error scenarios. This allows for more granular permission checks and improves test coverage for authorization logic.

hikaru-0602 · 2026-02-10T02:25:36Z

@kantacky
マージしてよい？

kantacky

LGTM

kantacky · 2026-02-10T02:27:18Z

まだコメント残ってるけど...
とりあえず影響なさそうだしいいや

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-10T02:28:08Z

internal/handler/announcement_test.go

+			assert.False(t, response.Announcements[0].AvailableFrom.IsZero(), "AvailableFromが設定されていること")
+			assert.False(t, response.Announcements[0].AvailableUntil.IsZero(), "AvailableUntilが設定されていること")


api.AnnouncementServiceAnnouncement.AvailableUntil は *time.Time なので、response.Announcements[0].AvailableUntil.IsZero() はコンパイルできません。AvailableUntil != nil の確認をした上で response.Announcements[0].AvailableUntil.IsZero() を呼ぶ（もしくは *response... をデリファレンスして IsZero()）形に修正してください。

Suggested change

assert.False(t, response.Announcements[0].AvailableFrom.IsZero(), "AvailableFromが設定されていること")

assert.False(t, response.Announcements[0].AvailableUntil.IsZero(), "AvailableUntilが設定されていること")

assert.False(t, response.Announcements[0].AvailableFrom.IsZero(), "AvailableFromが設定されていること")

assert.NotNil(t, response.Announcements[0].AvailableUntil, "AvailableUntilが設定されていること")

assert.False(t, response.Announcements[0].AvailableUntil.IsZero(), "AvailableUntilがゼロ時刻でないこと")

Copilot · 2026-02-10T02:28:09Z

internal/handler/announcement_test.go

+func TestAnnouncementsV1Detail(t *testing.T) {
+	tests := []struct {
+		name           string
+		id             string
+		withAdminClaim bool
+		customClaims   map[string]interface{} // 指定時はこのクレームでトークンをセット（403検証用）
+		wantCode       int
+		validate       func(t *testing.T, w *httptest.ResponseRecorder)
+	}{
+		{
+			name:           "正常にお知らせ詳細が取得できる",
+			id:             "1",
+			withAdminClaim: true,
+			wantCode:       http.StatusOK,
+			validate: func(t *testing.T, w *httptest.ResponseRecorder) {
+				var response struct {
+					Announcement api.AnnouncementServiceAnnouncement `json:"announcement"`
+				}
+				err := json.Unmarshal(w.Body.Bytes(), &response)
+				assert.NoError(t, err, "JSONのパースに失敗しました")
+				assert.Equal(t, "1", response.Announcement.Id)
+				assert.Equal(t, "お知らせ1", response.Announcement.Title)
+				assert.Equal(t, "https://example.com/1", response.Announcement.Url)
+			},
+		},


AnnouncementsV1Detail はハンドラ側で RequireAnyClaim(c, "admin", "developer") を使っているので、List/Create/Delete と同様に developer クレームのみで 200 になるケースもテストに追加したいです（現状 Detail は admin と 401/403 しか検証していません）。

Copilot · 2026-02-10T02:28:09Z

internal/handler/announcement_test.go

+func TestAnnouncementsV1Update(t *testing.T) {
+	now := time.Now()
+	until := now.Add(24 * time.Hour)
+
+	tests := []struct {
+		name           string
+		id             string
+		request        api.AnnouncementServiceAnnouncementRequest
+		withAdminClaim bool
+		customClaims   map[string]interface{} // 指定時はこのクレームでトークンをセット（403検証用）
+		wantCode       int
+		validate       func(t *testing.T, w *httptest.ResponseRecorder)
+	}{
+		{
+			name: "正常にお知らせを更新できる",
+			id:   "1",
+			request: api.AnnouncementServiceAnnouncementRequest{
+				Title:          "更新されたお知らせ",
+				Url:            "https://example.com/updated",
+				AvailableFrom:  now,
+				AvailableUntil: &until,
+			},
+			withAdminClaim: true,
+			wantCode:       http.StatusOK,
+			validate: func(t *testing.T, w *httptest.ResponseRecorder) {
+				var response struct {
+					Announcement api.AnnouncementServiceAnnouncement `json:"announcement"`
+				}
+				err := json.Unmarshal(w.Body.Bytes(), &response)
+				assert.NoError(t, err, "JSONのパースに失敗しました")
+				assert.Equal(t, "1", response.Announcement.Id)
+				assert.Equal(t, "更新されたお知らせ", response.Announcement.Title)
+				assert.Equal(t, "https://example.com/updated", response.Announcement.Url)
+			},
+		},


AnnouncementsV1Update もハンドラ側で RequireAnyClaim(c, "admin", "developer") を使っているため、developer クレームのみで更新できる（200）ケースのテストが欲しいです。今のテストテーブルには developer 用の入力フラグがなく、admin と 401/403 のみになっています。

hikaru-0602 added 3 commits February 6, 2026 17:13

追加

5760f1c

リポジトリのモック作成

e121872

HandlerのAnnouncementテスト追加

fbc2ef0

hikaru-0602 requested review from kantacky and masaya-osuga February 6, 2026 08:15

hikaru-0602 self-assigned this Feb 6, 2026

hikaru-0602 requested review from a team and Copilot February 6, 2026 08:15

Copilot started reviewing on behalf of hikaru-0602 February 6, 2026 08:16 View session

Copilot AI reviewed Feb 6, 2026

View reviewed changes

kantacky approved these changes Feb 6, 2026

View reviewed changes

kantacky reviewed Feb 6, 2026

View reviewed changes

hikaru-0602 added 7 commits February 8, 2026 15:09

Announcementテストにカスタムクレームを使用した403エラー検証を追加

74836b2

Update authentication error assertions in announcement tests to check…

3a630f6

… for exact error message

Copilot AI review requested due to automatic review settings February 8, 2026 06:21

Copilot started reviewing on behalf of hikaru-0602 February 8, 2026 06:22 View session

Copilot AI reviewed Feb 8, 2026

View reviewed changes

hikaru-0602 added 4 commits February 8, 2026 16:50

Create時のステータスコードを201に修正

bdc58d5

Abortを修正

7d82fce

エラーを明示

29f980b

Add WriteHeaderNow call in AnnouncementsV1Delete handler for immediat…

25add9c

…e response

Copilot AI review requested due to automatic review settings February 8, 2026 08:09

Copilot started reviewing on behalf of hikaru-0602 February 8, 2026 08:10 View session

hikaru-0602 requested a review from kantacky February 8, 2026 08:11

Copilot AI reviewed Feb 8, 2026

View reviewed changes

internal/handler/announcement_test.go Outdated Show resolved Hide resolved

Update internal/handler/announcement_test.go

982fdb3

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings February 10, 2026 02:06

Copilot started reviewing on behalf of hikaru-0602 February 10, 2026 02:06 View session

Merge branch 'main' into feature/handler-announcement-test

2ff049e

Copilot AI reviewed Feb 10, 2026

View reviewed changes

internal/handler/announcement_test.go Outdated Show resolved Hide resolved

internal/handler/announcement_test.go Show resolved Hide resolved

hikaru-0602 added 3 commits February 10, 2026 11:19

型修正

a20f047

ゼロでは無いことを検証

b39ab96

Copilot AI review requested due to automatic review settings February 10, 2026 02:23

Copilot started reviewing on behalf of hikaru-0602 February 10, 2026 02:24 View session

kantacky approved these changes Feb 10, 2026

View reviewed changes

Copilot AI reviewed Feb 10, 2026

View reviewed changes

hikaru-0602 merged commit 6eb6284 into main Feb 10, 2026
7 checks passed

hikaru-0602 deleted the feature/handler-announcement-test branch February 10, 2026 02:37

		assert.Equal(t, "application/json; charset=utf-8", w.Header().Get("Content-Type"))
		},

		assert.False(t, response.Announcements[0].AvailableFrom.IsZero(), "AvailableFromが設定されていること")
		assert.False(t, response.Announcements[0].AvailableUntil.IsZero(), "AvailableUntilが設定されていること")

Conversation

hikaru-0602 commented Feb 6, 2026

やったこと

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kantacky left a comment

Choose a reason for hiding this comment

Uh oh!

kantacky left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

hikaru-0602 commented Feb 8, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

masaya-osuga commented Feb 8, 2026

Uh oh!

kantacky commented Feb 10, 2026

Uh oh!

hikaru-0602 commented Feb 10, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

kantacky commented Feb 10, 2026

Uh oh!

hikaru-0602 commented Feb 10, 2026

Uh oh!

kantacky left a comment

Choose a reason for hiding this comment

Uh oh!

kantacky commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

kantacky left a comment •

edited

Loading

kantacky commented Feb 10, 2026 •

edited

Loading