Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

# Copyright (C) 2019 Bloomberg LP 

# 

# 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. 

 

 

from contextlib import contextmanager 

 

import grpc 

 

from buildgrid._protos.build.bazel.remote.execution.v2 import remote_execution_pb2, remote_execution_pb2_grpc 

 

 

@contextmanager 

def query(channel, instance=None): 

"""Context manager generator for the :class:`ActionCacheClient` class.""" 

client = ActionCacheClient(channel, instance=instance) 

try: 

yield client 

finally: 

client.close() 

 

 

class ActionCacheClient: 

"""Remote ActionCache service client helper. 

 

The :class:`ActionCacheClient` class comes with a generator factory function 

that can be used together with the `with` statement for context management:: 

 

from buildgrid.client.actioncache import query 

 

with query(channel, instance='build') as action_cache: 

digest, action_result = action_cache.get(action_digest) 

""" 

 

def __init__(self, channel, instance=None): 

"""Initializes a new :class:`ActionCacheClient` instance. 

 

Args: 

channel (grpc.Channel): a gRPC channel to the ActionCache endpoint. 

instance (str, optional): the targeted instance's name. 

""" 

self.channel = channel 

 

self.instance_name = instance 

 

self.__actioncache_stub = remote_execution_pb2_grpc.ActionCacheStub(self.channel) 

 

# --- Public API --- 

 

def get(self, action_digest): 

"""Retrieves the cached :obj:`ActionResult` for a given :obj:`Action`. 

 

Args: 

action_digest (:obj:`Digest`): the action's digest to query. 

 

Returns: 

:obj:`ActionResult`: the cached result or None if not found. 

 

Raises: 

grpc.RpcError: on any network or remote service error. 

""" 

request = remote_execution_pb2.GetActionResultRequest() 

if self.instance_name: 

request.instance_name = self.instance_name 

request.action_digest.CopyFrom(action_digest) 

 

try: 

return self.__actioncache_stub.GetActionResult(request) 

 

except grpc.RpcError as e: 

status_code = e.code() 

if status_code != grpc.StatusCode.NOT_FOUND: 

raise ConnectionError(e.details()) 

 

return None 

 

def update(self, action_digest, action_result): 

"""Maps in cache an :obj:`Action` to an :obj:`ActionResult`. 

 

Args: 

action_digest (:obj:`Digest`): the action's digest to update. 

action_result (:obj:`ActionResult`): the action's result. 

 

Returns: 

:obj:`ActionResult`: the cached result or None on failure. 

 

Raises: 

grpc.RpcError: on any network or remote service error. 

""" 

request = remote_execution_pb2.UpdateActionResultRequest() 

if self.instance_name: 

request.instance_name = self.instance_name 

request.action_digest.CopyFrom(action_digest) 

request.action_result.CopyFrom(action_result) 

 

try: 

return self.__actioncache_stub.UpdateActionResult(request) 

 

except grpc.RpcError as e: 

status_code = e.code() 

if status_code != grpc.StatusCode.NOT_FOUND: 

raise ConnectionError(e.details()) 

 

return None 

 

def close(self): 

"""Closes the underlying connection stubs.""" 

self.__actioncache_stub = None