mirror of
https://github.com/ossf/scorecard.git
synced 2024-09-17 11:57:12 +03:00
d55dbd12e6
* change file access method to io.ReadCloser callers don't always need the full file. large files are slow and can cause crashes. Signed-off-by: Spencer Schrock <sschrock@google.com> * switch tests to hardcoded readers Previously they returned bytes or strings, which have corresponding NewReader types. Since they don't need to be closed, io.NopCloser works well to give them a fake Close. Signed-off-by: Spencer Schrock <sschrock@google.com> * switch tests which called os.ReadFile to os.Open os.File fufills io.ReadCloser, so this is an easy change Signed-off-by: Spencer Schrock <sschrock@google.com> * break tarball tests into two steps: reader and read The rest of the test was kept the same to minimize the change. Signed-off-by: Spencer Schrock <sschrock@google.com> * ossfuzz doesn't implement GetFileReader Signed-off-by: Spencer Schrock <sschrock@google.com> * appease linter during refactor Signed-off-by: Spencer Schrock <sschrock@google.com> * switch git client to new method add check which ensures git client fulfills the interface Signed-off-by: Spencer Schrock <sschrock@google.com> --------- Signed-off-by: Spencer Schrock <sschrock@google.com>
62 lines
2.3 KiB
Go
62 lines
2.3 KiB
Go
// Copyright 2021 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 clients defines the interface for RepoClient and related structs.
|
|
package clients
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"io"
|
|
"time"
|
|
)
|
|
|
|
// ErrUnsupportedFeature indicates an API that is not supported by the client.
|
|
var ErrUnsupportedFeature = errors.New("unsupported feature")
|
|
|
|
// HeadSHA is default commitSHA value used to denote git HEAD.
|
|
const HeadSHA = "HEAD"
|
|
|
|
// RepoClient interface is used by Scorecard checks to access a repo.
|
|
type RepoClient interface {
|
|
InitRepo(repo Repo, commitSHA string, commitDepth int) error
|
|
URI() string
|
|
IsArchived() (bool, error)
|
|
ListFiles(predicate func(string) (bool, error)) ([]string, error)
|
|
// Returns an absolute path to the local repository
|
|
// in the format that matches the local OS
|
|
LocalPath() (string, error)
|
|
// GetFileReader returns an io.ReadCloser corresponding to the desired file.
|
|
// Callers should ensure to Close the Reader when finished.
|
|
GetFileReader(filename string) (io.ReadCloser, error)
|
|
GetBranch(branch string) (*BranchRef, error)
|
|
GetCreatedAt() (time.Time, error)
|
|
GetDefaultBranchName() (string, error)
|
|
GetDefaultBranch() (*BranchRef, error)
|
|
GetOrgRepoClient(context.Context) (RepoClient, error)
|
|
ListCommits() ([]Commit, error)
|
|
ListIssues() ([]Issue, error)
|
|
ListLicenses() ([]License, error)
|
|
ListReleases() ([]Release, error)
|
|
ListContributors() ([]User, error)
|
|
ListSuccessfulWorkflowRuns(filename string) ([]WorkflowRun, error)
|
|
ListCheckRunsForRef(ref string) ([]CheckRun, error)
|
|
ListStatuses(ref string) ([]Status, error)
|
|
ListWebhooks() ([]Webhook, error)
|
|
ListProgrammingLanguages() ([]Language, error)
|
|
Search(request SearchRequest) (SearchResponse, error)
|
|
SearchCommits(request SearchCommitsOptions) ([]Commit, error)
|
|
Close() error
|
|
}
|