Began adding tests.

Author: michaelsafyan

opentelemetry-instrumentation/src/opentelemetry/instrumentation/_blobupload/api/__init__.py

@@ -1,16 +1,35 @@
 """Exposes API methods to callers from the package name."""
 
-from opentelemetry.instrumentation._blobupload.api.constants import NOT_UPLOADED
 from opentelemetry.instrumentation._blobupload.api.blob import Blob
-from opentelemetry.instrumentation._blobupload.api.blob_uploader import BlobUploader
-from opentelemetry.instrumentation._blobupload.api.content_type import detect_content_type
+from opentelemetry.instrumentation._blobupload.api.blob_uploader import (
+    BlobUploader,
+)
+from opentelemetry.instrumentation._blobupload.api.constants import (
+    NOT_UPLOADED,
+)
+from opentelemetry.instrumentation._blobupload.api.content_type import (
+    detect_content_type,
+)
 from opentelemetry.instrumentation._blobupload.api.labels import (
-    generate_labels_for_span,
     generate_labels_for_event,
-    generate_labels_for_span_event
+    generate_labels_for_span,
+    generate_labels_for_span_event,
 )
 from opentelemetry.instrumentation._blobupload.api.provider import (
     BlobUploaderProvider,
+    get_blob_uploader,
     set_blob_uploader_provider,
-    get_glob_uploader
 )
+
+__all__ = [
+    Blob,
+    BlobUploader,
+    NOT_UPLOADED,
+    detect_content_type,
+    generate_labels_for_event,
+    generate_labels_for_span,
+    generate_labels_for_span_event,
+    BlobUploaderProvider,
+    get_blob_uploader,
+    set_blob_uploader_provider,
+]

opentelemetry-instrumentation/src/opentelemetry/instrumentation/_blobupload/api/blob.py

@@ -1,3 +1,5 @@
+from typing import Dict, Optional
+
 import base64
 
 class Blob(object):
@@ -11,7 +13,7 @@ class Blob(object):
          the object such as {"trace_id": "...", "span_id": "...", "filename": ...}
     """
 
-    def __init__(self, raw_bytes: bytes, content_type: Optional[str]=None, labels: Optional[dict]=None):
+    def __init__(self, raw_bytes: bytes, content_type: Optional[str]=None, labels: Optional[Dict[str, str]]=None):
         """Initialize the blob with an explicit set of properties.
         
         Args:
@@ -24,7 +26,7 @@ def __init__(self, raw_bytes: bytes, content_type: Optional[str]=None, labels: O
         self._labels = labels or {}
 
     @staticmethod
-    def from_data_uri(cls, uri: str, labels: Optional[dict]=None) -> Blob:
+    def from_data_uri(cls, uri: str, labels: Optional[dict]=None) -> 'Blob':
         """Instantiate a blob from a 'data:...' URI.
 
         Args:        
@@ -67,6 +69,6 @@ def content_type(self) -> Optional[str]:
         return self._content_type
 
     @property
-    def labels(self) -> dict:
+    def labels(self) -> Dict[str, str]:
         """Returns the key/value metadata of this Blob."""
         return _frozendict(self._labels)

opentelemetry-instrumentation/src/opentelemetry/instrumentation/_blobupload/api/blob_uploader.py

@@ -5,6 +5,7 @@
 from opentelemetry.instrumentation._blobupload.api.constants import NOT_UPLOADED
 from opentelemetry.instrumentation._blobupload.api.blob import Blob
 
+
 class BlobUploader(abc.ABC):
     """Pure abstract base class representing a component that does blob uploading."""
 

opentelemetry-instrumentation/src/opentelemetry/instrumentation/_blobupload/api/content_type.py

@@ -5,7 +5,7 @@
 class _FallBackModule(object):
     """Class that is shaped like the portion of 'magic' we need."""
 
-    def from_buffer(self, raw_bytes):
+    def from_buffer(self, raw_bytes, mime=True):
         """Fallback, subpar implementation of 'from_buffer'."""
         return 'application/octet-stream'
 
@@ -21,4 +21,4 @@ def from_buffer(self, raw_bytes):
 
 def detect_content_type(raw_bytes: bytes) -> str:
     """Attempts to infer the content type of the specified data."""
-    return _module.from_buffer(raw_bytes)
+    return _module.from_buffer(raw_bytes, mime=True)

opentelemetry-instrumentation/src/opentelemetry/instrumentation/_blobupload/api/labels.py

@@ -1,6 +1,6 @@
 """Provides utilities for providing basic identifying labels for blobs."""
 
-def generate_labels_for_span(trace_id, span_id) -> dict:
+def generate_labels_for_span(trace_id: str, span_id: str) -> dict:
     """Returns metadata for a span."""
     return {
         'otel_type': 'span',
@@ -9,7 +9,7 @@ def generate_labels_for_span(trace_id, span_id) -> dict:
     }
 
 
-def generate_labels_for_event(trace_id, span_id, event_name) -> dict:
+def generate_labels_for_event(trace_id: str, span_id: str, event_name: str) -> dict:
     """Returns metadata for an event."""
     result = generate_labels_for_span(trace_id, span_id)
     result.update({
@@ -19,7 +19,7 @@ def generate_labels_for_event(trace_id, span_id, event_name) -> dict:
     return result
 
 
-def generate_labels_for_span_event(trace_id, span_id, event_name, event_index) -> dict:
+def generate_labels_for_span_event(trace_id: str, span_id: str, event_name: str, event_index: int) -> dict:
     """Returns metadata for a span event."""
     result = generate_labels_for_event(trace_id, span_id, event_name)
     result.update({

opentelemetry-instrumentation/src/opentelemetry/instrumentation/_blobupload/api/provider.py

@@ -1,7 +1,10 @@
+from typing import Optional
+
 import abc
 import logging
 
-from opentelemetry.instrumentation._blobupload.api import BlobUploader
+from opentelemetry.instrumentation._blobupload.api.blob import Blob
+from opentelemetry.instrumentation._blobupload.api.blob_uploader import BlobUploader
 
 
 _logger = logging.getLogger(__name__)

opentelemetry-instrumentation/src/opentelemetry/instrumentation/_blobupload/backend/registry.py

@@ -0,0 +1,53 @@
+#! /usr/bin/env python3
+
+if __name__ == '__main__':
+    import sys
+    sys.path.append('../../../src')
+
+from opentelemetry.instrumentation._blobupload.api import detect_content_type
+from PIL import Image
+
+import io
+import unittest
+
+
+def create_test_image(format):
+    """Helper for creating a PIL Image for verifying image format support."""
+    test_img = Image.new('RGB', (2, 2))
+    output_buffer = io.BytesIO()
+    test_img.save(output_buffer, format)
+    result = output_buffer.getvalue()
+    output_buffer.close()
+    test_img.close()
+    return result
+
+
+class TestContentType(unittest.TestCase):
+
+    def test_detects_plaintext(self):
+        input = 'this is just regular text'
+        output = detect_content_type(input.encode())
+        self.assertEqual(output, 'text/plain')
+
+    def test_detects_json(self):
+        input = '''{
+            "this": {
+                "contains": "json"
+            }
+        }'''
+        output = detect_content_type(input.encode())
+        self.assertEqual(output, 'application/json')
+
+    def test_detects_jpeg(self):
+        input = create_test_image('jpeg')
+        output = detect_content_type(input)
+        self.assertEqual(output, 'image/jpeg')
+
+    def test_detects_png(self):
+        input = create_test_image('png')
+        output = detect_content_type(input)
+        self.assertEqual(output, 'image/png')
+
+
+if __name__ == '__main__':
+    unittest.main()

opentelemetry-instrumentation/tests/_blobupload/api/test_content_type.py

@@ -0,0 +1,67 @@
+#! /usr/bin/env python3
+
+if __name__ == '__main__':
+    import sys
+    sys.path.append('../../../src')
+
+from opentelemetry.instrumentation._blobupload.api import (
+    generate_labels_for_span,
+    generate_labels_for_event,
+    generate_labels_for_span_event)
+
+import unittest
+
+
+class TestLabels(unittest.TestCase):
+
+    def test_generate_labels_for_span(self):
+        trace_id = 'test-trace-id'
+        span_id = 'test-span-id'
+        labels = generate_labels_for_span(
+            trace_id=trace_id,
+            span_id=span_id
+        )
+        self.assertEqual(labels, {
+            'otel_type': 'span',
+            'trace_id': 'test-trace-id',
+            'span_id': 'test-span-id'
+        })
+
+    def test_generate_labels_for_event(self):
+        trace_id = 'test-trace-id'
+        span_id = 'test-span-id'
+        event_name = 'some-event'
+        labels = generate_labels_for_event(
+            trace_id=trace_id,
+            span_id=span_id,
+            event_name=event_name
+        )
+        self.assertEqual(labels, {
+            'otel_type': 'event',
+            'trace_id': 'test-trace-id',
+            'span_id': 'test-span-id',
+            'event_name': 'some-event'
+        })
+
+    def test_generate_labels_for_span_event(self):
+        trace_id = 'test-trace-id'
+        span_id = 'test-span-id'
+        event_name = 'some-event'
+        event_index = 2
+        labels = generate_labels_for_span_event(
+            trace_id=trace_id,
+            span_id=span_id,
+            event_name=event_name,
+            event_index=event_index
+        )
+        self.assertEqual(labels, {
+            'otel_type': 'span_event',
+            'trace_id': 'test-trace-id',
+            'span_id': 'test-span-id',
+            'event_name': 'some-event',
+            'event_index': 2
+        })
+
+
+if __name__ == '__main__':
+    unittest.main()