Add E2E search test for Azure DevOps

Signed-off-by: Jamie Magee <[email protected]>

Author: JamieMagee

Makefile

@@ -356,6 +356,14 @@ e2e-gitlab: ## Runs e2e tests for GitLab only. TOKEN_TYPE is not used (since the
 e2e-gitlab: build-scorecard | $(GINKGO)
 	TEST_GITLAB_EXTERNAL=1 TOKEN_TYPE="PAT" $(GINKGO)  --race -p -vv -coverprofile=e2e-coverage.out --keep-separate-coverprofiles --focus ".*GitLab" ./...
 
+e2e-azure-devops-token: ## Runs e2e tests that require a AZURE_DEVOPS_AUTH_TOKEN
+e2e-azure-devops-token: build-scorecard check-env-gitlab | $(GINKGO)
+	TEST_AZURE_DEVOPS_EXTERNAL=1 TOKEN_TYPE="GITLAB_PAT" $(GINKGO) --race -p -vv -coverprofile=e2e-coverage.out --keep-separate-coverprofiles --focus '.*Azure DevOps' ./...
+
+e2e-azure-devops: ## Runs e2e tests for Azure DevOps only. TOKEN_TYPE is not used (since these are public APIs), but must be set to something
+e2e-azure-devops: build-scorecard | $(GINKGO)
+	TEST_AZURE_DEVOPS_EXTERNAL=1 TOKEN_TYPE="PAT" $(GINKGO)  --race -p -vv -coverprofile=e2e-coverage.out --keep-separate-coverprofiles --focus ".*Azure DevOps" ./...
+
 e2e-attestor: ## Runs e2e tests for scorecard-attestor
 	cd attestor/e2e; go test -covermode=atomic -coverprofile=e2e-coverage.out; cd ../..
 

clients/azuredevopsrepo/azure_devops_suite_test.go

@@ -0,0 +1,35 @@
+// Copyright 2024 OpenSSF Scorecard Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package azuredevopsrepo
+
+import (
+	"os"
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestAzureDevOpsRepoE2E(t *testing.T) {
+	if val, exists := os.LookupEnv("SKIP_GINKGO"); exists && val == "1" {
+		t.Skip()
+	}
+	if val, exists := os.LookupEnv("TEST_AZURE_DEVOPS_EXTERNAL"); !exists || val != "1" {
+		t.Skip()
+	}
+	t.Parallel()
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Azure DevOps Repo Suite")
+}

clients/azuredevopsrepo/search.go

@@ -18,6 +18,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"strings"
 	"sync"
 
 	"github.com/microsoft/azure-devops-go-api/azuredevops/v7/search"
@@ -47,7 +48,7 @@ type (
 )
 
 func (s *searchHandler) search(request clients.SearchRequest) (clients.SearchResponse, error) {
-	filters, err := s.buildFilters(request)
+	filters, query, err := s.buildFilters(request)
 	if err != nil {
 		return clients.SearchResponse{}, fmt.Errorf("handler.buildQuery: %w", err)
 	}
@@ -56,7 +57,7 @@ func (s *searchHandler) search(request clients.SearchRequest) (clients.SearchRes
 	args := search.FetchCodeSearchResultsArgs{
 		Request: &search.CodeSearchRequest{
 			Filters:    &filters,
-			SearchText: &request.Query,
+			SearchText: &query,
 			Top:        &searchResultsPageSize,
 		},
 	}
@@ -68,11 +69,14 @@ func (s *searchHandler) search(request clients.SearchRequest) (clients.SearchRes
 	return searchResponseFrom(searchResults), nil
 }
 
-func (s *searchHandler) buildFilters(request clients.SearchRequest) (map[string][]string, error) {
+func (s *searchHandler) buildFilters(request clients.SearchRequest) (map[string][]string, string, error) {
 	filters := make(map[string][]string)
+	query := strings.Builder{}
 	if request.Query == "" {
-		return filters, fmt.Errorf("%w", errEmptyQuery)
+		return filters, query.String(), fmt.Errorf("%w", errEmptyQuery)
 	}
+	query.WriteString(request.Query)
+	query.WriteString(" ")
 
 	filters["Project"] = []string{s.repourl.project}
 	filters["Repository"] = []string{s.repourl.name}
@@ -81,10 +85,10 @@ func (s *searchHandler) buildFilters(request clients.SearchRequest) (map[string]
 		filters["Path"] = []string{request.Path}
 	}
 	if request.Filename != "" {
-		filters["Filename"] = []string{request.Filename}
+		query.WriteString(fmt.Sprintf("file:%s", request.Filename))
 	}
 
-	return filters, nil
+	return filters, query.String(), nil
 }
 
 func searchResponseFrom(searchResults *search.CodeSearchResponse) clients.SearchResponse {

clients/azuredevopsrepo/search_e2e_test.go

@@ -0,0 +1,49 @@
+// Copyright 2024 OpenSSF Scorecard Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package azuredevopsrepo
+
+import (
+	"context"
+
+	"github.com/ossf/scorecard/v5/clients"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("E2E TEST: azuredevopsrepo.searchHandler", func() {
+	Context("Search - Azure DevOps", func() {
+		It("Should return search results", func() {
+			Skip("We don't have a public Azure DevOps repo to test against")
+			repo, err := MakeAzureDevOpsRepo("https://dev.azure.com/jamiemagee/jamiemagee/_git/scorecard")
+			Expect(err).Should(BeNil())
+
+			repoClient, err := CreateAzureDevOpsClient(context.Background(), repo)
+			Expect(err).Should(BeNil())
+
+			err = repoClient.InitRepo(repo, clients.HeadSHA, 0)
+			Expect(err).Should(BeNil())
+
+			request := clients.SearchRequest{
+				Query:    "scorecard",
+				Filename: "README.md",
+			}
+			results, err := repoClient.Search(request)
+			Expect(err).Should(BeNil())
+			Expect(results.Hits).Should(BeNumerically(">", 0))
+			Expect(len(results.Results)).Should(BeNumerically(">", 0))
+		})
+	})
+})

clients/azuredevopsrepo/search_test.go

@@ -32,6 +32,7 @@ func Test_buildFilters(t *testing.T) {
 		repourl         *Repo
 		request         clients.SearchRequest
 		expectedErr     error
+		expectedQuery   string
 		name            string
 	}{
 		{
@@ -44,6 +45,7 @@ func Test_buildFilters(t *testing.T) {
 				name:    "repo",
 			},
 			expectedFilters: make(map[string][]string),
+			expectedQuery:   "",
 			expectedErr:     errEmptyQuery,
 		},
 		{
@@ -59,7 +61,8 @@ func Test_buildFilters(t *testing.T) {
 				"Project":    {"project"},
 				"Repository": {"repo"},
 			},
-			expectedErr: nil,
+			expectedQuery: "query ",
+			expectedErr:   nil,
 		},
 		{
 			name: "query and path",
@@ -76,7 +79,8 @@ func Test_buildFilters(t *testing.T) {
 				"Repository": {"repo"},
 				"Path":       {"path"},
 			},
-			expectedErr: nil,
+			expectedQuery: "query ",
+			expectedErr:   nil,
 		},
 		{
 			name: "query and filename",
@@ -91,9 +95,9 @@ func Test_buildFilters(t *testing.T) {
 			expectedFilters: map[string][]string{
 				"Project":    {"project"},
 				"Repository": {"repo"},
-				"Filename":   {"filename"},
 			},
-			expectedErr: nil,
+			expectedQuery: "query file:filename",
+			expectedErr:   nil,
 		},
 		{
 			name: "query, path, and filename",
@@ -110,9 +114,9 @@ func Test_buildFilters(t *testing.T) {
 				"Project":    {"project"},
 				"Repository": {"repo"},
 				"Path":       {"path"},
-				"Filename":   {"filename"},
 			},
-			expectedErr: nil,
+			expectedQuery: "query file:filename",
+			expectedErr:   nil,
 		},
 	}
 
@@ -122,10 +126,13 @@ func Test_buildFilters(t *testing.T) {
 			s := searchHandler{
 				repourl: tt.repourl,
 			}
-			filters, err := s.buildFilters(tt.request)
+			filters, query, err := s.buildFilters(tt.request)
 			if tt.expectedErr != nil && !errors.Is(err, tt.expectedErr) {
 				t.Fatalf("buildFilters() error = %v, ExpectedErr %v", err, tt.expectedErr)
 			}
+			if query != tt.expectedQuery {
+				t.Errorf("buildFilters() query = %v, ExpectedQuery %v", query, tt.expectedQuery)
+			}
 			if diff := cmp.Diff(filters, tt.expectedFilters); diff != "" {
 				t.Errorf("buildFilters() mismatch (-want +got):\n%s", diff)
 			}