Enable linting of tests (#227)

Changes for including flake8 in tests folder

Signed-off-by: pravar <[email protected]>

Author: pravarag

Makefile

@@ -66,7 +66,7 @@ clean:
 
 .PHONY: lint
 lint:
-	$(flake8) $(projects)
+	$(flake8) $(projects) tests
 	./scripts/check-license.sh
 
 .PHONY: shell

setup.cfg

@@ -1,8 +1,7 @@
 [flake8]
 ignore = D100,D101,D102,D103,D104,D105,D203,D204,D205,D400
 max-line-length = 100
-exclude = 
-  tests/*,
+exclude =
   jaeger_client/thrift_gen/*,
   crossdock/thrift_gen/*
 

tests/conftest.py

@@ -25,5 +25,6 @@ def tracer():
     return Tracer(
         service_name='test_service_1', reporter=reporter, sampler=sampler)
 
+
 AsyncHTTPClient.configure('tornado.curl_httpclient.CurlAsyncHTTPClient')
 print('Configured AsyncHTTPClient to use tornado.curl_httpclient.CurlAsyncHTTPClient')

tests/test_TUDPTransport.py

@@ -13,8 +13,6 @@
 # limitations under the License.
 
 from __future__ import absolute_import
-
-import mock
 import unittest
 
 from jaeger_client.TUDPTransport import TUDPTransport
@@ -26,7 +24,7 @@ def setUp(self):
 
     def test_constructor_blocking(self):
         t = TUDPTransport('127.0.0.1', 12345, blocking=True)
-        assert t.transport_sock.gettimeout() == None
+        assert t.transport_sock.gettimeout() is None
 
     def test_constructor_nonblocking(self):
         t = TUDPTransport('127.0.0.1', 12345, blocking=False)
@@ -36,11 +34,11 @@ def test_write(self):
         self.t.write(b'hello')
 
     def test_isopen_when_open(self):
-        assert self.t.isOpen() == True
+        assert self.t.isOpen() is True
 
     def test_isopen_when_closed(self):
         self.t.close()
-        assert self.t.isOpen() == False
+        assert self.t.isOpen() is False
 
     def test_close(self):
         self.t.close()

tests/test_codecs.py

@@ -37,7 +37,6 @@
 
 class TestCodecs(unittest.TestCase):
 
-
     def test_abstract_codec(self):
         codec = Codec()
         with self.assertRaises(NotImplementedError):
@@ -208,7 +207,6 @@ def test_context_from_readable_headers(self):
                 'hermes': 'LaBarbara Hermes',
             }
 
-
     def test_context_from_large_ids(self):
         codec = TextCodec(trace_id_header='Trace_ID',
                           baggage_header_prefix='Trace-Attr-')
@@ -306,7 +304,8 @@ def test_b3_codec_inject_parent(self):
         span = Span(context=ctx, operation_name='x', tracer=None, start_time=1)
         carrier = {}
         codec.inject(span_context=span, carrier=carrier)
-        assert carrier == {'X-B3-SpanId': format(127, 'x').zfill(16), 'X-B3-ParentSpanId': format(32, 'x').zfill(16),
+        assert carrier == {'X-B3-SpanId': format(127, 'x').zfill(16),
+                           'X-B3-ParentSpanId': format(32, 'x').zfill(16),
                            'X-B3-TraceId': format(256, 'x').zfill(16), 'X-B3-Sampled': '1'}
 
     def test_b3_extract(self):
@@ -500,9 +499,9 @@ def test_baggage_as_unicode_strings_with_httplib(httpserver):
         span.set_baggage_item(b[0], b[1])
 
         headers = {}
-        tracer.inject(
-            span_context=span.context, format=Format.TEXT_MAP, carrier=headers
-        )
+        tracer.inject(span_context=span.context,
+                      format=Format.TEXT_MAP,
+                      carrier=headers)
         # make sure httplib doesn't blow up
         request = urllib_under_test.Request(httpserver.url, None, headers)
         response = urllib_under_test.urlopen(request)

tests/test_config.py

@@ -60,7 +60,7 @@ def test_const_sampler(self):
     def test_probabilistic_sampler(self):
         with self.assertRaises(Exception):
             cfg = {'sampler': {'type': 'probabilistic', 'param': 'xx'}}
-            _ = Config(cfg, service_name='x').sampler
+            Config(cfg, service_name='x').sampler
         c = Config({'sampler': {'type': 'probabilistic', 'param': 0.5}},
                    service_name='x')
         assert type(c.sampler) is ProbabilisticSampler
@@ -69,7 +69,7 @@ def test_probabilistic_sampler(self):
     def test_rate_limiting_sampler(self):
         with self.assertRaises(Exception):
             cfg = {'sampler': {'type': 'rate_limiting', 'param': 'xx'}}
-            _ = Config(cfg, service_name='x').sampler
+            Config(cfg, service_name='x').sampler
         c = Config({'sampler': {'type': 'rate_limiting', 'param': 1234}},
                    service_name='x')
         assert type(c.sampler) is RateLimitingSampler
@@ -133,18 +133,18 @@ def test_throttler(self):
 
     def test_for_unexpected_config_entries(self):
         with self.assertRaises(Exception):
-            _ = Config({"unexpected":"value"}, validate=True)
+            Config({'unexpected': 'value'}, validate=True)
 
     def test_reporter_queue_size_valid(self):
-        config = Config({"reporter_queue_size": 100}, service_name='x', validate=True)
+        config = Config({'reporter_queue_size': 100}, service_name='x', validate=True)
         assert config.reporter_queue_size == 100
 
     def test_missing_service_name(self):
         with self.assertRaises(ValueError):
-            _ = Config({})
+            Config({})
 
     def test_disable_metrics(self):
-        config = Config({ 'metrics': False }, service_name='x')
+        config = Config({'metrics': False}, service_name='x')
         assert isinstance(config._metrics_factory, MetricsFactory)
 
     def test_initialize_tracer(self):

tests/test_crossdock.py

@@ -21,14 +21,15 @@
 import pytest
 import opentracing
 from mock import MagicMock
-if six.PY2:
-    from crossdock.server import server
 from tornado.httpclient import HTTPRequest
 from jaeger_client import Tracer, ConstSampler
 from jaeger_client.reporter import InMemoryReporter
 from crossdock.server.endtoend import EndToEndHandler, _determine_host_port, _parse_host_port
 
-tchannel_port = "9999"
+if six.PY2:
+    from crossdock.server import server
+
+tchannel_port = '9999'
 
 
 @pytest.fixture
@@ -54,16 +55,16 @@ def tracer():
 
 
 PERMUTATIONS = []
-for s2 in ["HTTP", "TCHANNEL"]:
-    for s3 in ["HTTP", "TCHANNEL"]:
+for s2 in ['HTTP', 'TCHANNEL']:
+    for s3 in ['HTTP', 'TCHANNEL']:
         for sampled in [True, False]:
             PERMUTATIONS.append((s2, s3, sampled))
 
 
 # noinspection PyShadowingNames
 @pytest.mark.parametrize('s2_transport,s3_transport,sampled', PERMUTATIONS)
 @pytest.mark.gen_test
-@pytest.mark.skipif(six.PY3, reason="crossdock tests need tchannel that only works with Python 2.7")
+@pytest.mark.skipif(six.PY3, reason='crossdock tests need tchannel that only works with Python 2.7')
 def test_trace_propagation(
         s2_transport, s3_transport, sampled, tracer,
         base_url, http_port, http_client):
@@ -77,32 +78,32 @@ def test_trace_propagation(
     )
 
     level3 = dict()
-    level3["serviceName"] = "python"
-    level3["serverRole"] = "s3"
-    level3["transport"] = s3_transport
-    level3["host"] = "localhost"
-    level3["port"] = str(http_port) if s3_transport == "HTTP" else tchannel_port
+    level3['serviceName'] = 'python'
+    level3['serverRole'] = 's3'
+    level3['transport'] = s3_transport
+    level3['host'] = 'localhost'
+    level3['port'] = str(http_port) if s3_transport == 'HTTP' else tchannel_port
 
     level2 = dict()
-    level2["serviceName"] = "python"
-    level2["serverRole"] = "s2"
-    level2["transport"] = s2_transport
-    level2["host"] = "localhost"
-    level2["port"] = str(http_port) if s2_transport == "HTTP" else tchannel_port
-    level2["downstream"] = level3
+    level2['serviceName'] = 'python'
+    level2['serverRole'] = 's2'
+    level2['transport'] = s2_transport
+    level2['host'] = 'localhost'
+    level2['port'] = str(http_port) if s2_transport == 'HTTP' else tchannel_port
+    level2['downstream'] = level3
 
     level1 = dict()
-    level1["baggage"] = "Zoidberg"
-    level1["serverRole"] = "s1"
-    level1["sampled"] = sampled
-    level1["downstream"] = level2
+    level1['baggage'] = 'Zoidberg'
+    level1['serverRole'] = 's1'
+    level1['sampled'] = sampled
+    level1['downstream'] = level2
     body = json.dumps(level1)
 
     with mock.patch('opentracing.tracer', tracer):
-        assert opentracing.tracer == tracer # sanity check that patch worked
+        assert opentracing.tracer == tracer  # sanity check that patch worked
 
-        req = HTTPRequest(url="%s/start_trace" % base_url, method="POST",
-                          headers={"Content-Type": "application/json"},
+        req = HTTPRequest(url='%s/start_trace' % base_url, method='POST',
+                          headers={'Content-Type': 'application/json'},
                           body=body,
                           request_timeout=2)
 
@@ -111,40 +112,41 @@ def test_trace_propagation(
         tr = server.serializer.traceresponse_from_json(response.body)
         assert tr is not None
         assert tr.span is not None
-        assert tr.span.baggage == level1.get("baggage")
+        assert tr.span.baggage == level1.get('baggage')
         assert tr.span.sampled == sampled
         assert tr.span.traceId is not None
         assert tr.downstream is not None
-        assert tr.downstream.span.baggage == level1.get("baggage")
+        assert tr.downstream.span.baggage == level1.get('baggage')
         assert tr.downstream.span.sampled == sampled
         assert tr.downstream.span.traceId == tr.span.traceId
         assert tr.downstream.downstream is not None
-        assert tr.downstream.downstream.span.baggage == level1.get("baggage")
+        assert tr.downstream.downstream.span.baggage == level1.get('baggage')
         assert tr.downstream.downstream.span.sampled == sampled
         assert tr.downstream.downstream.span.traceId == tr.span.traceId
 
 
 # noinspection PyShadowingNames
 @pytest.mark.gen_test
-@pytest.mark.skipif(six.PY3, reason="crossdock tests need tchannel that only works with Python 2.7")
+@pytest.mark.skipif(six.PY3, reason='crossdock tests need tchannel that only works with Python 2.7')
 def test_endtoend_handler(tracer):
     payload = dict()
-    payload["operation"] = "Zoidberg"
-    payload["count"] = 2
-    payload["tags"] = {"key":"value"}
+    payload['operation'] = 'Zoidberg'
+    payload['count'] = 2
+    payload['tags'] = {'key': 'value'}
     body = json.dumps(payload)
 
     h = EndToEndHandler()
     request = MagicMock(body=body)
     response_writer = MagicMock()
     response_writer.finish.return_value = None
 
-    h.tracers = {"remote": tracer}
+    h.tracers = {'remote': tracer}
     h.generate_traces(request, response_writer)
 
     spans = tracer.reporter.get_spans()
     assert len(spans) == 2
 
+
 def test_determine_host_port():
     original_value = os.environ.get('AGENT_HOST_PORT', None)
     os.environ['AGENT_HOST_PORT'] = 'localhost:1234'
@@ -157,6 +159,7 @@ def test_determine_host_port():
     assert host == 'localhost'
     assert port == 1234
 
+
 def test_parse_host_port():
     test_cases = [
         [('', 'localhost', 5678), ('localhost', 5678)],

tests/test_local_agent_net.py

@@ -41,19 +41,23 @@
 
 test_client_id = 12345678
 
+
 class AgentHandler(tornado.web.RequestHandler):
     def get(self):
         self.write(test_strategy)
 
+
 class CreditHandler(tornado.web.RequestHandler):
     def get(self):
         self.write(test_credits)
 
+
 application = tornado.web.Application([
-    (r"/sampling", AgentHandler),
-    (r"/credits", CreditHandler),
+    (r'/sampling', AgentHandler),
+    (r'/credits', CreditHandler),
 ])
 
+
 @pytest.fixture
 def app():
     return application
@@ -70,6 +74,7 @@ def test_request_sampling_strategy(http_client, base_url):
     response = yield sender.request_sampling_strategy(service_name='svc', timeout=15)
     assert response.body == test_strategy.encode('utf-8')
 
+
 @pytest.mark.gen_test
 def test_request_throttling_credits(http_client, base_url):
     o = urlparse(base_url)
@@ -80,8 +85,8 @@ def test_request_throttling_credits(http_client, base_url):
         throttling_port=o.port,
     )
     response = yield sender.request_throttling_credits(
-                                service_name='svc',
-                                client_id=test_client_id,
-                                operations=['test-operation'],
-                                timeout=15)
+        service_name='svc',
+        client_id=test_client_id,
+        operations=['test-operation'],
+        timeout=15)
     assert response.body == test_credits.encode('utf-8')

tests/test_metrics.py

@@ -68,15 +68,15 @@ def test_legacy_metrics_factory():
     tm = mock.MagicMock()
     gm = mock.MagicMock()
     mf = LegacyMetricsFactory(Metrics(count=cm, timing=tm, gauge=gm))
-    counter = mf.create_counter(name='foo', tags={'k':'v','a':'counter'})
+    counter = mf.create_counter(name='foo', tags={'k': 'v', 'a': 'counter'})
     counter(1)
     assert cm.call_args == (('foo.a_counter.k_v', 1),)
 
-    gauge = mf.create_gauge(name='bar', tags={'k':'v', 'a':'gauge'})
+    gauge = mf.create_gauge(name='bar', tags={'k': 'v', 'a': 'gauge'})
     gauge(2)
     assert gm.call_args == (('bar.a_gauge.k_v', 2),)
 
-    timing = mf.create_timer(name='rawr', tags={'k':'v', 'a':'timer'})
+    timing = mf.create_timer(name='rawr', tags={'k': 'v', 'a': 'timer'})
     timing(3)
     assert tm.call_args == (('rawr.a_timer.k_v', 0.003),)
 
@@ -89,11 +89,11 @@ def test_legacy_metrics_factory():
 
 def test_legacy_metrics_factory_noop():
     mf = LegacyMetricsFactory(Metrics())
-    counter = mf.create_counter(name='foo', tags={'a':'counter'})
+    counter = mf.create_counter(name='foo', tags={'a': 'counter'})
     counter(1)
 
-    gauge = mf.create_gauge(name='bar', tags={'a':'gauge'})
+    gauge = mf.create_gauge(name='bar', tags={'a': 'gauge'})
     gauge(2)
 
-    timing = mf.create_timer(name='rawr', tags={'a':'timer'})
+    timing = mf.create_timer(name='rawr', tags={'a': 'timer'})
     timing(3)

tests/test_noop_tracer.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 from __future__ import absolute_import
 
 import opentracing
@@ -32,7 +33,9 @@ def test_new_trace():
     assert child.get_baggage_item('Fry') is None
     carrier = {}
     tracer.inject(
-        span_context=child.context, format=Format.TEXT_MAP, carrier=carrier)
+        span_context=child.context,
+        format=Format.TEXT_MAP,
+        carrier=carrier)
     assert carrier == dict()
     child.finish()