/
githubtesting.go
58 lines (53 loc) · 1.62 KB
/
githubtesting.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
// Copyright 2020-2024 Buf Technologies, Inc.
//
// 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 githubtesting provides testing functionality for GitHub.
package githubtesting
import (
"context"
"net/http"
"github.com/bufbuild/buf/private/pkg/storage/storageos"
"go.uber.org/zap"
)
// ArchiveReader reads GitHub archives.
type ArchiveReader interface {
// GetArchive gets the GitHub archive and untars it to the output directory path.
//
// The root directory within the tarball is stripped.
// If the directory already exists, this is a no-op.
//
// Uses file locking to make sure the no-op works properly across multiple process invocations,
// which is needed for example with go test.
// This is also thread-safe.
//
// Only use for testing.
GetArchive(
ctx context.Context,
outputDirPath string,
owner string,
repository string,
ref string,
) error
}
// NewArchiveReader returns a new ArchiveReader.
func NewArchiveReader(
logger *zap.Logger,
storageosProvider storageos.Provider,
httpClient *http.Client,
) ArchiveReader {
return newArchiveReader(
logger,
storageosProvider,
httpClient,
)
}