Skip to content

Commit df87dba

Browse files
c24tc24t
authored
Rename monitored_resource_util package (census-instrumentation#511)
1 parent 4eb2f79 commit df87dba

File tree

9 files changed

+92
-77
lines changed

9 files changed

+92
-77
lines changed

‎opencensus/common/monitored_resource_util/__init__.py‎ renamed to ‎opencensus/common/monitored_resource/__init__.py‎

File renamed without changes.

‎opencensus/common/monitored_resource_util/aws_identity_doc_utils.py‎ renamed to ‎opencensus/common/monitored_resource/aws_identity_doc_utils.py‎

File renamed without changes.

‎opencensus/common/monitored_resource_util/gcp_metadata_config.py‎ renamed to ‎opencensus/common/monitored_resource/gcp_metadata_config.py‎

File renamed without changes.

‎opencensus/common/monitored_resource_util/monitored_resource.py‎ renamed to ‎opencensus/common/monitored_resource/monitored_resource.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
import os
1616

1717
from opencensus.common import resource
18-
from opencensus.common.monitored_resource_util import aws_identity_doc_utils
19-
from opencensus.common.monitored_resource_util import gcp_metadata_config
18+
from opencensus.common.monitored_resource import aws_identity_doc_utils
19+
from opencensus.common.monitored_resource import gcp_metadata_config
2020

2121

2222
# Supported environments (resource types)

‎opencensus/stats/exporters/stackdriver_exporter.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
from google.cloud import monitoring_v3
2525

2626
from opencensus.common import utils
27-
from opencensus.common.monitored_resource_util import monitored_resource
27+
from opencensus.common.monitored_resource import monitored_resource
2828
from opencensus.common.transports import async_
2929
from opencensus.common.version import __version__
3030
from opencensus.stats import aggregation

‎opencensus/trace/exporters/stackdriver_exporter.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
from google.cloud.trace.client import Client
1919

20-
from opencensus.common.monitored_resource_util import monitored_resource
20+
from opencensus.common.monitored_resource import monitored_resource
2121
from opencensus.common.transports import sync
2222
from opencensus.common.version import __version__
2323
from opencensus.trace import attributes_helper

‎tests/unit/common/monitored_resource_util/test_aws_identity_doc_utils.py‎

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,15 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
import unittest
16-
import mock
1715
import json
18-
from opencensus.common.monitored_resource_util.aws_identity_doc_utils \
19-
import AwsIdentityDocumentUtils
20-
from opencensus.common.monitored_resource_util import \
21-
aws_identity_doc_utils
16+
import mock
17+
import unittest
18+
19+
from opencensus.common.monitored_resource import aws_identity_doc_utils
2220

2321

2422
class TestAwsIdentityDocumentUtils(unittest.TestCase):
25-
@mock.patch('opencensus.common.monitored_resource_util.'
23+
@mock.patch('opencensus.common.monitored_resource.'
2624
'aws_identity_doc_utils.get_request')
2725
def test_get_aws_metadata(self, http_request_mock):
2826
mocked_http_response = {
@@ -40,13 +38,15 @@ def test_get_aws_metadata(self, http_request_mock):
4038
}
4139

4240
http_request_mock.return_value = json.dumps(mocked_http_response)
43-
AwsIdentityDocumentUtils.inited = False
44-
AwsIdentityDocumentUtils.is_running = False
41+
aws_identity_doc_utils.AwsIdentityDocumentUtils.inited = False
42+
aws_identity_doc_utils.AwsIdentityDocumentUtils.is_running = False
4543
aws_identity_doc_utils.aws_metadata_map = {}
4644

47-
self.assertTrue(AwsIdentityDocumentUtils.is_running_on_aws())
45+
self.assertTrue(aws_identity_doc_utils.AwsIdentityDocumentUtils
46+
.is_running_on_aws())
4847

49-
labels_list = AwsIdentityDocumentUtils().get_aws_metadata()
48+
labels_list = aws_identity_doc_utils.AwsIdentityDocumentUtils(
49+
).get_aws_metadata()
5050

5151
self.assertEquals(len(labels_list), 3)
5252

@@ -58,7 +58,7 @@ def test_get_aws_metadata(self, http_request_mock):
5858

5959
self.assertEquals(labels_list, expected_labels)
6060

61-
@mock.patch('opencensus.common.monitored_resource_util.'
61+
@mock.patch('opencensus.common.monitored_resource.'
6262
'aws_identity_doc_utils.get_request')
6363
def test_get_aws_metadata_none_fields(self, http_request_mock):
6464
mocked_http_response = {
@@ -75,13 +75,15 @@ def test_get_aws_metadata_none_fields(self, http_request_mock):
7575
}
7676

7777
http_request_mock.return_value = json.dumps(mocked_http_response)
78-
AwsIdentityDocumentUtils.inited = False
79-
AwsIdentityDocumentUtils.is_running = False
78+
aws_identity_doc_utils.AwsIdentityDocumentUtils.inited = False
79+
aws_identity_doc_utils.AwsIdentityDocumentUtils.is_running = False
8080
aws_identity_doc_utils.aws_metadata_map = {}
8181

82-
self.assertTrue(AwsIdentityDocumentUtils.is_running_on_aws())
82+
self.assertTrue(aws_identity_doc_utils.AwsIdentityDocumentUtils
83+
.is_running_on_aws())
8384

84-
labels_list = AwsIdentityDocumentUtils().get_aws_metadata()
85+
labels_list = aws_identity_doc_utils.AwsIdentityDocumentUtils(
86+
).get_aws_metadata()
8587

8688
self.assertEquals(len(labels_list), 2)
8789

@@ -92,16 +94,18 @@ def test_get_aws_metadata_none_fields(self, http_request_mock):
9294

9395
self.assertEquals(labels_list, expected_labels)
9496

95-
@mock.patch('opencensus.common.monitored_resource_util.'
97+
@mock.patch('opencensus.common.monitored_resource.'
9698
'aws_identity_doc_utils.get_request')
9799
def test_aws_not_running(self, http_request_mock):
98100
http_request_mock.return_value = None
99101
aws_identity_doc_utils.inited = False
100102
aws_identity_doc_utils.is_running_on_aws = False
101103
aws_identity_doc_utils.aws_metadata_map = {}
102104

103-
self.assertFalse(AwsIdentityDocumentUtils.is_running_on_aws())
105+
self.assertFalse(aws_identity_doc_utils.AwsIdentityDocumentUtils
106+
.is_running_on_aws())
104107

105-
labels_list = AwsIdentityDocumentUtils().get_aws_metadata()
108+
labels_list = aws_identity_doc_utils.AwsIdentityDocumentUtils(
109+
).get_aws_metadata()
106110

107111
self.assertEquals(len(labels_list), 0)

‎tests/unit/common/monitored_resource_util/test_gcp_metadata_config.py‎

Lines changed: 56 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,17 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
import unittest
1615
import mock
1716
import os
18-
from opencensus.common.monitored_resource_util.gcp_metadata_config \
19-
import GcpMetadataConfig
20-
from opencensus.common.monitored_resource_util import gcp_metadata_config
17+
import unittest
2118

19+
from opencensus.common.monitored_resource import gcp_metadata_config
2220

23-
class TestGcpMetadataConfig(unittest.TestCase):
2421

25-
@mock.patch('opencensus.common.monitored_resource_util.'
22+
class TestGcpMetadataConfig(unittest.TestCase):
23+
@mock.patch('opencensus.common.monitored_resource.'
2624
'gcp_metadata_config.get_request')
2725
def test_get_gce_metadata(self, http_request_mock):
28-
2926
def assign_attribute_value(*args, **kwargs):
3027
attribute_uri = args[0].split('/')[-1]
3128
if attribute_uri == 'id':
@@ -36,13 +33,15 @@ def assign_attribute_value(*args, **kwargs):
3633
return 'us-east1'
3734

3835
http_request_mock.side_effect = assign_attribute_value
39-
GcpMetadataConfig.inited = False
40-
GcpMetadataConfig.is_running = False
36+
gcp_metadata_config.GcpMetadataConfig.inited = False
37+
gcp_metadata_config.GcpMetadataConfig.is_running = False
4138
gcp_metadata_config.gcp_metadata_map = {}
4239

43-
self.assertTrue(GcpMetadataConfig.is_running_on_gcp())
40+
self.assertTrue(
41+
gcp_metadata_config.GcpMetadataConfig.is_running_on_gcp())
4442

45-
labels_list = GcpMetadataConfig().get_gce_metadata()
43+
labels_list = gcp_metadata_config.GcpMetadataConfig().get_gce_metadata(
44+
)
4645

4746
self.assertEquals(len(labels_list), 3)
4847

@@ -54,12 +53,13 @@ def assign_attribute_value(*args, **kwargs):
5453

5554
self.assertEquals(labels_list, expected_labels)
5655

57-
@mock.patch('opencensus.common.monitored_resource_util.'
56+
@mock.patch('opencensus.common.monitored_resource.'
5857
'gcp_metadata_config.get_request')
5958
def test_get_gce_metadata_binary_strings(self, http_request_mock):
6059
"""
6160
At least in python 3 binary strings are returned from urllib
6261
"""
62+
6363
def assign_attribute_value(*args, **kwargs):
6464
attribute_uri = args[0].split('/')[-1]
6565
if attribute_uri == 'id':
@@ -70,13 +70,15 @@ def assign_attribute_value(*args, **kwargs):
7070
return b'us-east1'
7171

7272
http_request_mock.side_effect = assign_attribute_value
73-
GcpMetadataConfig.inited = False
74-
GcpMetadataConfig.is_running = False
73+
gcp_metadata_config.GcpMetadataConfig.inited = False
74+
gcp_metadata_config.GcpMetadataConfig.is_running = False
7575
gcp_metadata_config.gcp_metadata_map = {}
7676

77-
self.assertTrue(GcpMetadataConfig.is_running_on_gcp())
77+
self.assertTrue(
78+
gcp_metadata_config.GcpMetadataConfig.is_running_on_gcp())
7879

79-
labels_list = GcpMetadataConfig().get_gce_metadata()
80+
labels_list = gcp_metadata_config.GcpMetadataConfig().get_gce_metadata(
81+
)
8082

8183
self.assertEquals(len(labels_list), 3)
8284

@@ -88,16 +90,17 @@ def assign_attribute_value(*args, **kwargs):
8890

8991
self.assertEquals(labels_list, expected_labels)
9092

91-
@mock.patch.dict(os.environ,
92-
{'KUBERNETES_SERVICE_HOST': '127.0.0.1',
93-
'CONTAINER_NAME': 'container',
94-
'NAMESPACE': 'namespace',
95-
'HOSTNAME': 'localhost'}, clear=True
96-
)
97-
@mock.patch('opencensus.common.monitored_resource_util.'
93+
@mock.patch.dict(
94+
os.environ, {
95+
'KUBERNETES_SERVICE_HOST': '127.0.0.1',
96+
'CONTAINER_NAME': 'container',
97+
'NAMESPACE': 'namespace',
98+
'HOSTNAME': 'localhost'
99+
},
100+
clear=True)
101+
@mock.patch('opencensus.common.monitored_resource.'
98102
'gcp_metadata_config.get_request')
99103
def test_get_gke_metadata(self, http_request_mock):
100-
101104
def assign_attribute_value(*args, **kwargs):
102105
attribute_uri = args[0].split('/')[-1]
103106
if attribute_uri == 'id':
@@ -110,13 +113,15 @@ def assign_attribute_value(*args, **kwargs):
110113
return 'us-east1'
111114

112115
http_request_mock.side_effect = assign_attribute_value
113-
GcpMetadataConfig.inited = False
114-
GcpMetadataConfig.is_running = False
116+
gcp_metadata_config.GcpMetadataConfig.inited = False
117+
gcp_metadata_config.GcpMetadataConfig.is_running = False
115118
gcp_metadata_config.gcp_metadata_map = {}
116119

117-
self.assertTrue(GcpMetadataConfig.is_running_on_gcp())
120+
self.assertTrue(
121+
gcp_metadata_config.GcpMetadataConfig.is_running_on_gcp())
118122

119-
labels_list = GcpMetadataConfig().get_gke_metadata()
123+
labels_list = gcp_metadata_config.GcpMetadataConfig().get_gke_metadata(
124+
)
120125

121126
self.assertEquals(len(labels_list), 7)
122127

@@ -132,15 +137,16 @@ def assign_attribute_value(*args, **kwargs):
132137

133138
self.assertEquals(labels_list, expected_labels)
134139

135-
@mock.patch.dict(os.environ,
136-
{'KUBERNETES_SERVICE_HOST': '127.0.0.1',
137-
'NAMESPACE': 'namespace',
138-
'HOSTNAME': 'localhost'}, clear=True
139-
)
140-
@mock.patch('opencensus.common.monitored_resource_util.'
140+
@mock.patch.dict(
141+
os.environ, {
142+
'KUBERNETES_SERVICE_HOST': '127.0.0.1',
143+
'NAMESPACE': 'namespace',
144+
'HOSTNAME': 'localhost'
145+
},
146+
clear=True)
147+
@mock.patch('opencensus.common.monitored_resource.'
141148
'gcp_metadata_config.get_request')
142149
def test_get_gke_metadata_container_empty(self, http_request_mock):
143-
144150
def assign_attribute_value(*args, **kwargs):
145151
attribute_uri = args[0].split('/')[-1]
146152
if attribute_uri == 'id':
@@ -151,13 +157,15 @@ def assign_attribute_value(*args, **kwargs):
151157
return 'us-east1'
152158

153159
http_request_mock.side_effect = assign_attribute_value
154-
GcpMetadataConfig.inited = False
155-
GcpMetadataConfig.is_running = False
160+
gcp_metadata_config.GcpMetadataConfig.inited = False
161+
gcp_metadata_config.GcpMetadataConfig.is_running = False
156162
gcp_metadata_config.gcp_metadata_map = {}
157163

158-
self.assertTrue(GcpMetadataConfig.is_running_on_gcp())
164+
self.assertTrue(
165+
gcp_metadata_config.GcpMetadataConfig.is_running_on_gcp())
159166

160-
labels_list = GcpMetadataConfig().get_gke_metadata()
167+
labels_list = gcp_metadata_config.GcpMetadataConfig().get_gke_metadata(
168+
)
161169

162170
self.assertEquals(len(labels_list), 5)
163171

@@ -172,15 +180,18 @@ def assign_attribute_value(*args, **kwargs):
172180
self.assertEquals(labels_list, expected_labels)
173181

174182
@mock.patch.dict(os.environ, clear=True)
175-
@mock.patch('opencensus.common.monitored_resource_util.'
183+
@mock.patch('opencensus.common.monitored_resource.'
176184
'gcp_metadata_config.get_request')
177185
def test_gcp_not_running(self, http_request_mock):
178186
http_request_mock.return_value = None
179-
GcpMetadataConfig.inited = False
180-
GcpMetadataConfig.is_running = False
187+
gcp_metadata_config.GcpMetadataConfig.inited = False
188+
gcp_metadata_config.GcpMetadataConfig.is_running = False
181189
gcp_metadata_config.gcp_metadata_map = {}
182190

183-
self.assertFalse(GcpMetadataConfig.is_running_on_gcp())
191+
self.assertFalse(
192+
gcp_metadata_config.GcpMetadataConfig.is_running_on_gcp())
184193

185-
self.assertEquals(len(GcpMetadataConfig().get_gce_metadata()), 0)
186-
self.assertEquals(len(GcpMetadataConfig().get_gke_metadata()), 0)
194+
self.assertEquals(
195+
len(gcp_metadata_config.GcpMetadataConfig().get_gce_metadata()), 0)
196+
self.assertEquals(
197+
len(gcp_metadata_config.GcpMetadataConfig().get_gke_metadata()), 0)

‎tests/unit/common/monitored_resource_util/test_monitored_resource.py‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import os
1818
import unittest
1919

20-
from opencensus.common.monitored_resource_util import monitored_resource
20+
from opencensus.common.monitored_resource import monitored_resource
2121

2222

2323
@contextmanager
@@ -65,7 +65,7 @@ def mock_aws_env():
6565

6666
class TestMonitoredResource(unittest.TestCase):
6767

68-
@mock.patch('opencensus.common.monitored_resource_util.monitored_resource'
68+
@mock.patch('opencensus.common.monitored_resource.monitored_resource'
6969
'.gcp_metadata_config.GcpMetadataConfig')
7070
def test_gcp_gce_monitored_resource(self, gcp_metadata_mock):
7171
mocked_labels = {
@@ -82,7 +82,7 @@ def test_gcp_gce_monitored_resource(self, gcp_metadata_mock):
8282
self.assertEquals(resource.get_type(), 'gce_instance')
8383
self.assertEquals(resource.get_labels(), mocked_labels)
8484

85-
@mock.patch('opencensus.common.monitored_resource_util.monitored_resource'
85+
@mock.patch('opencensus.common.monitored_resource.monitored_resource'
8686
'.gcp_metadata_config.GcpMetadataConfig')
8787
def test_gcp_gke_monitored_resource(self, gcp_metadata_mock):
8888

@@ -104,7 +104,7 @@ def test_gcp_gke_monitored_resource(self, gcp_metadata_mock):
104104
self.assertEquals(resource.get_type(), 'gke_container')
105105
self.assertEquals(resource.get_labels(), mocked_labels)
106106

107-
@mock.patch('opencensus.common.monitored_resource_util.monitored_resource'
107+
@mock.patch('opencensus.common.monitored_resource.monitored_resource'
108108
'.aws_identity_doc_utils.AwsIdentityDocumentUtils')
109109
def test_aws_monitored_resource(self, aws_metadata_mock):
110110

@@ -135,7 +135,7 @@ def test_gke_environment(self):
135135

136136
def test_gce_environment(self):
137137
patch = mock.patch(
138-
'opencensus.common.monitored_resource_util.'
138+
'opencensus.common.monitored_resource.'
139139
'gcp_metadata_config.GcpMetadataConfig.'
140140
'is_running_on_gcp',
141141
return_value=True)
@@ -145,10 +145,10 @@ def test_gce_environment(self):
145145
self.assertIsNotNone(mr)
146146
self.assertEqual(mr.get_type(), "gce_instance")
147147

148-
@mock.patch('opencensus.common.monitored_resource_util.'
148+
@mock.patch('opencensus.common.monitored_resource.'
149149
'gcp_metadata_config.GcpMetadataConfig.is_running_on_gcp',
150150
return_value=False)
151-
@mock.patch('opencensus.common.monitored_resource_util.'
151+
@mock.patch('opencensus.common.monitored_resource.'
152152
'aws_identity_doc_utils.AwsIdentityDocumentUtils.'
153153
'is_running_on_aws',
154154
return_value=True)
@@ -158,10 +158,10 @@ def test_aws_environment(self, aws_util_mock, gcp_metadata_mock):
158158
self.assertIsNotNone(mr)
159159
self.assertEqual(mr.get_type(), "aws_ec2_instance")
160160

161-
@mock.patch('opencensus.common.monitored_resource_util.'
161+
@mock.patch('opencensus.common.monitored_resource.'
162162
'gcp_metadata_config.GcpMetadataConfig.is_running_on_gcp',
163163
return_value=False)
164-
@mock.patch('opencensus.common.monitored_resource_util.'
164+
@mock.patch('opencensus.common.monitored_resource.'
165165
'aws_identity_doc_utils.AwsIdentityDocumentUtils.'
166166
'is_running_on_aws',
167167
return_value=False)

0 commit comments

Comments
 (0)