github.com/web-platform-tests/wpt.fyi@v0.0.0-20240530210107-70cf978996f1/api/checks/update_test.go

//go:build small
// +build small

package checks

import (
	"context"
	"fmt"
	"net/url"
	"strings"
	"testing"

	"github.com/golang/mock/gomock"
	"github.com/stretchr/testify/assert"
	"github.com/web-platform-tests/wpt.fyi/api/checks/summaries"
	"github.com/web-platform-tests/wpt.fyi/shared"
	"github.com/web-platform-tests/wpt.fyi/shared/sharedtest"
)

func TestGetDiffSummary_Regressed(t *testing.T) {
	testSummary := func(enabled bool) {
		t.Run(fmt.Sprintf("%s=%v", onlyChangesAsRegressionsFeature, enabled), func(t *testing.T) {
			mockCtrl := gomock.NewController(t)
			defer mockCtrl.Finish()

			before, after := getBeforeAndAfterRuns()
			runDiff := shared.RunDiff{
				Differences: shared.ResultsDiff{"/foo.html": shared.TestDiff{0, 1, 0}},
			}

			aeAPI := sharedtest.NewMockAppEngineAPI(mockCtrl)
			aeAPI.EXPECT().Context().AnyTimes().Return(context.Background())
			aeAPI.EXPECT().IsFeatureEnabled(onlyChangesAsRegressionsFeature).Return(enabled)
			aeAPI.EXPECT().IsFeatureEnabled(failChecksOnRegressionFeature).Return(false)
			aeAPI.EXPECT().GetHostname()
			diffAPI := sharedtest.NewMockDiffAPI(mockCtrl)
			diffAPI.EXPECT().GetRunsDiff(before, after, sharedtest.SameDiffFilter("ADC"), gomock.Any()).Return(runDiff, nil)
			if enabled {
				diffAPI.EXPECT().GetRunsDiff(before, after, sharedtest.SameDiffFilter("C"), gomock.Any()).Return(runDiff, nil)
			}
			diffURL, _ := url.Parse("https://wpt.fyi/results?diff")
			diffAPI.EXPECT().GetDiffURL(before, after, gomock.Any()).Return(diffURL)
			diffAPI.EXPECT().GetMasterDiffURL(after, sharedtest.SameDiffFilter("ACU")).Return(diffURL)
			suite := shared.CheckSuite{
				PRNumbers: []int{123},
			}

			summary, err := getDiffSummary(aeAPI, diffAPI, suite, before, after)
			assert.Nil(t, err)
			_, ok := summary.(summaries.Regressed)
			assert.True(t, ok)
			assert.Equal(t, suite.PRNumbers, summary.GetCheckState().PRNumbers)
		})
	}
	testSummary(false)
	testSummary(true)
}

func TestGetDiffSummary_Completed(t *testing.T) {
	mockCtrl := gomock.NewController(t)
	defer mockCtrl.Finish()

	before, after := getBeforeAndAfterRuns()
	runDiff := shared.RunDiff{
		Differences: shared.ResultsDiff{"/foo.html": shared.TestDiff{1, 0, 1}},
	}

	aeAPI := sharedtest.NewMockAppEngineAPI(mockCtrl)
	aeAPI.EXPECT().Context().AnyTimes().Return(context.Background())
	aeAPI.EXPECT().IsFeatureEnabled(onlyChangesAsRegressionsFeature).Return(false)
	aeAPI.EXPECT().IsFeatureEnabled(failChecksOnRegressionFeature).Return(false)
	aeAPI.EXPECT().GetHostname()
	diffAPI := sharedtest.NewMockDiffAPI(mockCtrl)
	diffAPI.EXPECT().GetRunsDiff(before, after, gomock.Any(), gomock.Any()).Return(runDiff, nil)
	diffURL, _ := url.Parse("https://wpt.fyi/results?diff")
	diffAPI.EXPECT().GetDiffURL(before, after, gomock.Any()).Return(diffURL)
	diffAPI.EXPECT().GetMasterDiffURL(after, sharedtest.SameDiffFilter("ACU")).Return(diffURL)
	suite := shared.CheckSuite{
		PRNumbers: []int{123},
	}

	summary, err := getDiffSummary(aeAPI, diffAPI, suite, before, after)
	assert.Nil(t, err)
	_, ok := summary.(summaries.Completed)
	assert.True(t, ok)
	assert.Equal(t, suite.PRNumbers, summary.GetCheckState().PRNumbers)
}

func getBeforeAndAfterRuns() (before, after shared.TestRun) {
	before.FullRevisionHash = strings.Repeat("0", 40)
	before.BrowserName = "chrome"
	before.Labels = []string{shared.PRBaseLabel}
	after.FullRevisionHash = strings.Repeat("1", 40)
	after.BrowserName = "chrome"
	after.Labels = []string{shared.PRHeadLabel}
	return before, after
}

func TestCollapseSummary_Nesting(t *testing.T) {
	diff := shared.RunDiff{
		BeforeSummary: shared.ResultsSummary{
			"/foo/test.html":             shared.TestSummary{1, 1},
			"/foo/bar/test.html":         shared.TestSummary{1, 1},
			"/foo/bar/baz/test.html":     shared.TestSummary{1, 1},
			"/foo/bar/baz/qux/test.html": shared.TestSummary{1, 1},
		},
		AfterSummary: shared.ResultsSummary{
			"/foo/test.html":             shared.TestSummary{2, 2},
			"/foo/bar/test.html":         shared.TestSummary{2, 2},
			"/foo/bar/baz/test.html":     shared.TestSummary{2, 2},
			"/foo/bar/baz/qux/test.html": shared.TestSummary{2, 2},
		},
	}
	summary := summaries.BeforeAndAfter{
		"/foo/test.html":             summaries.TestBeforeAndAfter{PassingBefore: 1, TotalBefore: 1, PassingAfter: 2, TotalAfter: 2},
		"/foo/bar/test.html":         summaries.TestBeforeAndAfter{PassingBefore: 1, TotalBefore: 1, PassingAfter: 2, TotalAfter: 2},
		"/foo/bar/baz/test.html":     summaries.TestBeforeAndAfter{PassingBefore: 1, TotalBefore: 1, PassingAfter: 2, TotalAfter: 2},
		"/foo/bar/baz/qux/test.html": summaries.TestBeforeAndAfter{PassingBefore: 1, TotalBefore: 1, PassingAfter: 2, TotalAfter: 2},
	}
	assert.Equal(t, summary, collapseSummary(diff, 4))
	assert.Equal(t, summaries.BeforeAndAfter{
		"/foo/test.html":     summaries.TestBeforeAndAfter{PassingBefore: 1, TotalBefore: 1, PassingAfter: 2, TotalAfter: 2},
		"/foo/bar/test.html": summaries.TestBeforeAndAfter{PassingBefore: 1, TotalBefore: 1, PassingAfter: 2, TotalAfter: 2},
		"/foo/bar/baz/":      summaries.TestBeforeAndAfter{PassingBefore: 2, TotalBefore: 2, PassingAfter: 4, TotalAfter: 4},
	}, collapseSummary(diff, 3))
	assert.Equal(t, summaries.BeforeAndAfter{
		"/foo/test.html": summaries.TestBeforeAndAfter{PassingBefore: 1, TotalBefore: 1, PassingAfter: 2, TotalAfter: 2},
		"/foo/bar/":      summaries.TestBeforeAndAfter{PassingBefore: 3, TotalBefore: 3, PassingAfter: 6, TotalAfter: 6},
	}, collapseSummary(diff, 2))
	assert.Equal(t, summaries.BeforeAndAfter{
		"/foo/": summaries.TestBeforeAndAfter{PassingBefore: 4, TotalBefore: 4, PassingAfter: 8, TotalAfter: 8},
	}, collapseSummary(diff, 1))
}

func TestCollapseSummary_ManyFiles(t *testing.T) {
	diff := shared.RunDiff{
		BeforeSummary: make(shared.ResultsSummary),
		AfterSummary:  make(shared.ResultsSummary),
	}
	for i := 1; i <= 20; i++ {
		diff.BeforeSummary[fmt.Sprintf("/foo/test%v.html", i)] = shared.TestSummary{1, 1}
		diff.BeforeSummary[fmt.Sprintf("/bar/test%v.html", i)] = shared.TestSummary{1, 1}
		diff.BeforeSummary[fmt.Sprintf("/baz/test%v.html", i)] = shared.TestSummary{1, 1}
		diff.AfterSummary[fmt.Sprintf("/foo/test%v.html", i)] = shared.TestSummary{2, 3}
		diff.AfterSummary[fmt.Sprintf("/bar/test%v.html", i)] = shared.TestSummary{2, 3}
		diff.AfterSummary[fmt.Sprintf("/baz/test%v.html", i)] = shared.TestSummary{2, 3}
	}
	assert.Equal(t, summaries.BeforeAndAfter{
		"/foo/": summaries.TestBeforeAndAfter{PassingBefore: 20, TotalBefore: 20, PassingAfter: 40, TotalAfter: 60},
		"/bar/": summaries.TestBeforeAndAfter{PassingBefore: 20, TotalBefore: 20, PassingAfter: 40, TotalAfter: 60},
		"/baz/": summaries.TestBeforeAndAfter{PassingBefore: 20, TotalBefore: 20, PassingAfter: 40, TotalAfter: 60},
	}, collapseSummary(diff, 10))
	// A number too small still does its best to collapse.
	assert.Equal(t, summaries.BeforeAndAfter{
		"/foo/": summaries.TestBeforeAndAfter{PassingBefore: 20, TotalBefore: 20, PassingAfter: 40, TotalAfter: 60},
		"/bar/": summaries.TestBeforeAndAfter{PassingBefore: 20, TotalBefore: 20, PassingAfter: 40, TotalAfter: 60},
		"/baz/": summaries.TestBeforeAndAfter{PassingBefore: 20, TotalBefore: 20, PassingAfter: 40, TotalAfter: 60},
	}, collapseSummary(diff, 1))
}