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

# 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 abc import ABC, abstractmethod 

 

 

class DataStoreInterface(ABC): # pragma: no cover 

 

"""Abstract class defining an interface to a data storage backend. 

 

This provides methods for storing the internal state of BuildGrid, 

and retrieving it in order to reconstruct state on restart. 

 

""" 

 

@abstractmethod 

def activate_monitoring(self): 

raise NotImplementedError() 

 

@abstractmethod 

def deactivate_monitoring(self): 

raise NotImplementedError() 

 

@abstractmethod 

def get_job_by_action(self, action_digest): 

raise NotImplementedError() 

 

@abstractmethod 

def get_job_by_name(self, name): 

raise NotImplementedError() 

 

@abstractmethod 

def get_job_by_operation(self, operation): 

raise NotImplementedError() 

 

@abstractmethod 

def get_all_jobs(self): 

raise NotImplementedError() 

 

@abstractmethod 

def get_operations_by_stage(self, operation_stage): 

raise NotImplementedError() 

 

@abstractmethod 

def get_all_operations(self): 

raise NotImplementedError() 

 

@abstractmethod 

def get_leases_by_state(self, lease_state): 

raise NotImplementedError() 

 

@abstractmethod 

def create_job(self, job): 

raise NotImplementedError() 

 

@abstractmethod 

def create_operation(self, operation, job_name): 

raise NotImplementedError() 

 

@abstractmethod 

def create_lease(self, lease): 

raise NotImplementedError() 

 

@abstractmethod 

def update_job(self, job_name, changes): 

raise NotImplementedError() 

 

@abstractmethod 

def update_operation(self, operation_name, changes): 

raise NotImplementedError() 

 

@abstractmethod 

def update_lease(self, job_name, changes): 

raise NotImplementedError() 

 

@abstractmethod 

def delete_job(self, job_name): 

raise NotImplementedError() 

 

@abstractmethod 

def delete_operation(self, operation_name): 

raise NotImplementedError() 

 

@abstractmethod 

def load_unfinished_jobs(self): 

raise NotImplementedError() 

 

@abstractmethod 

def assign_lease_for_next_job(self, capabilities, callback, timeout=None): 

raise NotImplementedError()