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

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

# This file is part of daf_butler. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (http://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the GNU General Public License 

# along with this program. If not, see <http://www.gnu.org/licenses/>. 

 

from contextlib import contextmanager, closing 

import os 

import os.path 

import secrets 

from typing import List 

import unittest 

 

import sqlalchemy 

 

from lsst.daf.butler import DimensionUniverse, ddl 

from lsst.daf.butler.registry import RegistryConfig 

from lsst.daf.butler.registry.databases.oracle import OracleDatabase 

from lsst.daf.butler.registry import Registry 

from lsst.daf.butler.registry.tests import DatabaseTests, RegistryTests 

 

ENVVAR = "DAF_BUTLER_ORACLE_TEST_URI" 

TEST_URI = os.environ.get(ENVVAR) 

 

 

def cleanUpPrefixes(connection: sqlalchemy.engine.Connection, prefixes: List[str]): 

"""Drop all tables and other schema entities that start with any of the 

given prefixes. 

""" 

commands = [] 

dbapi = connection.connection 

with closing(dbapi.cursor()) as cursor: 

for objectType, objectName in cursor.execute("SELECT object_type, object_name FROM user_objects"): 

if not any(objectName.lower().startswith(prefix) for prefix in prefixes): 

continue 

if objectType == "TABLE": 

commands.append(f'DROP TABLE "{objectName}" CASCADE CONSTRAINTS') 

elif objectType in ("VIEW", "PROCEDURE", "SEQUENCE"): 

commands.append(f'DROP {objectType} "{objectName}"') 

for command in commands: 

cursor.execute(command) 

 

 

@unittest.skipUnless(TEST_URI is not None, f"{ENVVAR} environment variable not set.") 

class OracleDatabaseTestCase(unittest.TestCase, DatabaseTests): 

 

@classmethod 

def setUpClass(cls): 

# Create a single engine for all Database instances we create, to avoid 

# repeatedly spending time connecting. 

cls._connection = OracleDatabase.connect(TEST_URI) 

cls._prefixes = [] 

 

@classmethod 

def tearDownClass(cls): 

cleanUpPrefixes(cls._connection, cls._prefixes) 

 

def makeEmptyDatabase(self, origin: int = 0) -> OracleDatabase: 

prefix = f"test_{secrets.token_hex(8).lower()}_" 

self._prefixes.append(prefix) 

return OracleDatabase(origin=origin, connection=self._connection, prefix=prefix) 

 

def getNewConnection(self, database: OracleDatabase, *, writeable: bool) -> OracleDatabase: 

return OracleDatabase(origin=database.origin, connection=self._connection, 

prefix=database.prefix, writeable=writeable) 

 

@contextmanager 

def asReadOnly(self, database: OracleDatabase) -> OracleDatabase: 

yield self.getNewConnection(database, writeable=False) 

 

def testNameShrinking(self): 

"""Test that too-long names for database entities other than tables 

and columns (which we preserve, and just expect to fit) are shrunk. 

""" 

db = self.makeEmptyDatabase(origin=1) 

with db.declareStaticTables(create=True) as context: 

# Table and field names are each below the 128-char limit even when 

# accounting for the prefix, but their combination (which will 

# appear in sequences and constraints) is not. 

tableName = "a_table_with_a_very_very_very_very_very_very_very_very_long_72_char_name" 

fieldName1 = "a_column_with_a_very_very_very_very_very_very_very_very_long_73_char_name" 

fieldName2 = "another_column_with_a_very_very_very_very_very_very_very_very_long_79_char_name" 

context.addTable( 

tableName, 

ddl.TableSpec( 

fields=[ 

ddl.FieldSpec( 

fieldName1, 

dtype=sqlalchemy.BigInteger, 

autoincrement=True, 

primaryKey=True 

), 

ddl.FieldSpec( 

fieldName2, 

dtype=sqlalchemy.String, 

length=16, 

nullable=False, 

), 

], 

unique={(fieldName2,)}, 

) 

) 

# Add another table, this time dynamically, with a foreign key to the 

# first table. 

db.ensureTableExists( 

tableName + "_b", 

ddl.TableSpec( 

fields=[ 

ddl.FieldSpec( 

fieldName1 + "_b", 

dtype=sqlalchemy.BigInteger, 

autoincrement=True, 

primaryKey=True 

), 

ddl.FieldSpec( 

fieldName2 + "_b", 

dtype=sqlalchemy.String, 

length=16, 

nullable=False, 

), 

], 

foreignKeys=[ 

ddl.ForeignKeySpec(tableName, source=(fieldName2 + "_b",), target=(fieldName2,)), 

] 

) 

) 

 

 

@unittest.skipUnless(TEST_URI is not None, f"{ENVVAR} environment variable not set.") 

class OracleRegistryTestCase(unittest.TestCase, RegistryTests): 

"""Tests for `Registry` backed by an `Oracle` database. 

""" 

 

@classmethod 

def setUpClass(cls): 

# Create a single engine for all Database instances we create, to avoid 

# repeatedly spending time connecting. 

cls._connection = OracleDatabase.connect(TEST_URI) 

cls._prefixes = [] 

 

@classmethod 

def tearDownClass(cls): 

cleanUpPrefixes(cls._connection, cls._prefixes) 

 

def makeRegistry(self) -> Registry: 

prefix = f"test_{secrets.token_hex(8).lower()}_" 

self._prefixes.append(prefix) 

config = RegistryConfig() 

# Can't use Registry.fromConfig for these tests because we don't want 

# to reconnect to the server every single time. But we at least use 

# OracleDatabase.fromConnection rather than the constructor so 

# we can try to pass a prefix through via "+" in a namespace. 

database = OracleDatabase.fromConnection(connection=self._connection, origin=0, 

namespace=f"+{prefix}") 

return Registry(database=database, dimensions=DimensionUniverse(config), create=True) 

 

 

173 ↛ 174line 173 didn't jump to line 174, because the condition on line 173 was never trueif __name__ == "__main__": 

unittest.main()