go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/buildbucket/appengine/internal/clients/swarming.go (about)

     1  // Copyright 2022 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package clients
    16  
    17  import (
    18  	"context"
    19  	"net/http"
    20  	"time"
    21  
    22  	"go.chromium.org/luci/grpc/prpc"
    23  	"go.chromium.org/luci/server/auth"
    24  	apipb "go.chromium.org/luci/swarming/proto/api_v2"
    25  )
    26  
    27  // SwarmingClient is a Swarming API wrapper for buildbucket-specific usage.
    28  //
    29  // In prod, a SwarmingClient for interacting with the Swarming service will be
    30  // used. Tests should use a fake implementation.
    31  type SwarmingClient interface {
    32  	CreateTask(ctx context.Context, createTaskReq *apipb.NewTaskRequest) (*apipb.TaskRequestMetadataResponse, error)
    33  	GetTaskResult(ctx context.Context, taskID string) (*apipb.TaskResultResponse, error)
    34  	CancelTask(ctx context.Context, req *apipb.TaskCancelRequest) (*apipb.CancelResponse, error)
    35  }
    36  
    37  // swarmingServiceImpl for use in real production envs.
    38  type swarmingServiceImpl struct {
    39  	TasksClient apipb.TasksClient
    40  }
    41  
    42  // Ensure swarmingClientImpl implements SwarmingClient.
    43  var _ SwarmingClient = &swarmingServiceImpl{}
    44  
    45  var MockSwarmingClientKey = "used in tests only for setting the mock SwarmingClient"
    46  
    47  // NewSwarmingClient returns a new SwarmingClient to interact with Swarming APIs.
    48  func NewSwarmingClient(ctx context.Context, host string, project string) (SwarmingClient, error) {
    49  	if mockClient, ok := ctx.Value(&MockSwarmingClientKey).(*MockSwarmingClient); ok {
    50  		return mockClient, nil
    51  	}
    52  
    53  	t, err := auth.GetRPCTransport(ctx, auth.AsProject, auth.WithProject(project))
    54  	if err != nil {
    55  		return nil, err
    56  	}
    57  
    58  	prpcClient := prpc.Client{
    59  		C:    &http.Client{Transport: t},
    60  		Host: host,
    61  	}
    62  	return &swarmingServiceImpl{
    63  		TasksClient: apipb.NewTasksClient(&prpcClient),
    64  	}, nil
    65  }
    66  
    67  // CreateTask calls `apipb.TasksClient.NewTask` to create a task.
    68  func (s *swarmingServiceImpl) CreateTask(ctx context.Context, createTaskReq *apipb.NewTaskRequest) (*apipb.TaskRequestMetadataResponse, error) {
    69  	subCtx, cancel := context.WithTimeout(ctx, 60*time.Second)
    70  	defer cancel()
    71  	return s.TasksClient.NewTask(subCtx, createTaskReq)
    72  }
    73  
    74  // GetTaskResult calls `apipb.TasksClient.GetResult` to get the result of a task via a task id.
    75  func (s *swarmingServiceImpl) GetTaskResult(ctx context.Context, taskID string) (*apipb.TaskResultResponse, error) {
    76  	subCtx, cancel := context.WithTimeout(ctx, 60*time.Second)
    77  	defer cancel()
    78  	return s.TasksClient.GetResult(subCtx, &apipb.TaskIdWithPerfRequest{TaskId: taskID})
    79  }
    80  
    81  func (s *swarmingServiceImpl) CancelTask(ctx context.Context, req *apipb.TaskCancelRequest) (*apipb.CancelResponse, error) {
    82  	subCtx, cancel := context.WithTimeout(ctx, 60*time.Second)
    83  	defer cancel()
    84  	return s.TasksClient.CancelTask(subCtx, req)
    85  }