Merge pull request #3 from mirelap-amazon/main

Multiple minor clean-ups from previous PR.

Author: gimki

README.md

@@ -2,6 +2,12 @@
 
 For more details, check the documentation: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/what-is-codeguru-profiler.html
 
+## How to use it
+
+This package is released to PyPI, so use it as any Python package from PyPI: https://pypi.org/project/codeguru-profiler-agent
+
+For a demo application that uses this agent, check our [demo application](https://github.com/aws-samples/aws-codeguru-profiler-python-demo-application).
+
 ## Release to PyPI
 
 Use the `setup.py` script to create the archive.

codeguru_profiler_agent/aws_lambda/lambda_handler.py

@@ -22,8 +22,7 @@ def load_handler(bootstrap_module, env=os.environ, original_handler_env_key=HAND
         if hasattr(bootstrap_module, '_get_handler'):
             customer_handler_function = bootstrap_module._get_handler(original_handler_name)
         else:
-            # Support for python 3.6 bootstrap which is different. It is starting to be quite hacky at this point.
-            # We will need to discuss if it is worth handling this case and if we can do it in a better way.
+            # TODO FIXME Review if the support for python 3.6 bootstrap can be improved.
             # This returns both a init_handler and the function, we apply the init right away as we are in init process
             init_handler, customer_handler_function = bootstrap_module._get_handlers(
                 handler=original_handler_name,

codeguru_profiler_agent/model/sample.py

@@ -1,4 +1,6 @@
 class Sample:
+    __slots__ = ["stacks", "attempted_sample_threads_count", "seen_threads_count"]
+
     def __init__(self, stacks, attempted_sample_threads_count=0, seen_threads_count=0):
         """
         :param stacks: list of lists; each list is a list of Frame object representing a thread stack in bottom (of thread stack) to top (of thread stack) order

codeguru_profiler_agent/profiler.py

@@ -31,6 +31,7 @@
 # [B108:hardcoded_tmp_directory] Probable insecure usage of temp file/directory.
 # https://bandit.readthedocs.io/en/latest/plugins/b108_hardcoded_tmp_directory.html
 # This file can be used by the customer as kill switch for the Profiler.
+# TODO FIXME Consider making this work for Windows.
 KILLSWITCH_FILEPATH = "/var/tmp/killProfiler" #nosec
 
 logger = logging.getLogger(__name__)

setup.py

@@ -30,8 +30,8 @@ def find_version(*file_paths):
     description="The Python agent to be used for Amazon CodeGuru Profiler",
     long_description="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/what-is-codeguru-profiler.html",
     author="Amazon Web Services",
-    url="https://github.com/aws",
-    download_url="https://github.com/aws",
+    url="https://github.com/aws/amazon-codeguru-profiler-python-agent",
+    download_url="https://github.com/aws/amazon-codeguru-profiler-python-agent",
     classifiers=[
         "Programming Language :: Python :: 3",
         "Development Status :: 5 - Production/Stable",

test/conftest.py

@@ -1,4 +1,2 @@
-import pytest
-
-# Enable pytestutils @focus decoration
-pytest_plugins = "test.pytestutils_focus"
+# Enable pytestutils decoration
+pytest_plugins = "test.pytestutils"

test/integration/test_live_backend_reporting.py

@@ -18,9 +18,6 @@
 
 
 @pytest.mark.skipif(
-    # TODO FIXME Remove the conditions for skipping this on Amazonian fleets when we move fully to GitHub.
-    socket.gethostname().startswith("pb-worker-prod") or
-    socket.gethostname().startswith("coverlay-") or
     socket.getfqdn().endswith("internal.cloudapp.net"),  # hosts running ubuntu and windows in GitHub
     socket.getfqdn().endswith("ip6.arpa"),  # hosts running macs in GitHub
     reason="This integration test is skipped on any shared fleet from Amazon or GitHub "

test/pytestutils.py

@@ -5,8 +5,6 @@
 _pytestutils_before_global_counter = 0
 _pytestutils_before_global_lock = threading.Lock()
 
-_pytestutils_is_there_any_test_marked_with_focus = False
-
 
 def before(before_function):
     """
@@ -56,55 +54,3 @@ def test_it_does_stuff(self):
 
     return pytest.fixture(
         autouse=True, name=unique_fixture_name)(before_function)
-
-
-def focus(decorated_test):
-    """
-    Decorator for tagging a function or class as being in focus, and to switch the test suite execution to "focused
-    execution mode". When the test suite is in "focused execution mode", only functions and classes marked with @focus
-    are run, all others are skipped.
-
-    When there are no functions/classes marked with @focus, the test suite goes back to the usual mode, and all tests
-    are run.
-
-    The focused execution mode is useful for quickly and without needing to edit any more configuration/files selecting
-    only a subset of the tests for execution, to speed up testing cycles.
-
-    This decorator is inspired by similar IDE features (e.g. https://blogs.oracle.com/geertjan/run-focused-test-method )
-    and other test libraries (e.g. https://medium.com/table-xi/focus-your-rspec-workflow-4cd5798d2a3e ).
-
-    Limitation when used with Pytest < 3.6: @focus does not extend to nested classes, see
-    https://github.com/pytest-dev/pytest/issues/199 and https://github.com/pytest-dev/pytest/pull/3317 for details.
-
-    This feature is broken into several pieces:
-    * The @focus decorator sets a global variable to trigger the focused execution mode, and additionally marks any
-      test method or class with the "pytestutils_focus" marker
-    * In pytestutils_focus.py a pytest plugin is provided that when in focused execution mode, skips any tests not
-      marked with the "pytestutils_focus" marker
-    * In conftest.py we enable the pytest plugin
-    """
-    _validate_focus_enabled()
-
-    global _pytestutils_is_there_any_test_marked_with_focus
-
-    _pytestutils_is_there_any_test_marked_with_focus = True
-
-    return pytest.mark.pytestutils_focus(decorated_test)
-
-
-def _validate_focus_enabled():
-    if os.environ.get("PYTESTUTILS_ALLOW_FOCUS") in ("1", "true", "yes"):
-        return
-    raise RuntimeError("""
-Found tests annotated with @focus decorator, but the PYTESTUTILS_ALLOW_FOCUS environment variable is not set in the
-current environment.
-
-If you found this error in a CI environment, it means someone committed test code with a @focus annotation -- please
-check for and remove it from the codebase.
-
-If you found this error and you wanted to use @focus for your own development work, please add a PYTESTUTILS_ALLOW_FOCUS
-enviroment variable set to 1 (e.g. `export PYTESTUTILS_ALLOW_FOCUS=1`) to your execution environment to make this error
-go away.
-
-Thanks for using @focus!
-        """)

test/pytestutils_focus.py

@@ -87,4 +87,4 @@ def test_it_leaves_other_values_untouched(self):
             assert AgentConfiguration.get().sampling_interval == timedelta(milliseconds=1)
             assert AgentConfiguration.get().minimum_time_reporting == timedelta(seconds=1)
             assert AgentConfiguration.get().reporting_interval == timedelta(minutes=1)
-            assert AgentConfiguration.get().max_stack_depth == 998
+            assert AgentConfiguration.get().max_stack_depth == 998