Add a mode to allow crt to either be used as a default dependency wit…

.github/workflows/ci.yml

@@ -17,6 +17,7 @@ env:
   AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
   AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }}
   AWS_REGION: us-east-1
+  AWS_CRT_BUILD_STRICT_MODE: ON
 
 jobs:
   manylinux1:
@@ -265,6 +266,14 @@ jobs:
           python3 -m pip install -v awscrt-1.0.0.dev0.tar.gz
           python3 -c "import awscrt.io"
 
+  non-strict-system-mode:
+    runs-on: ubuntu-22.04 #latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Non Strict/System Mode
+      run: |
+        ./codebuild/test-sys-install-mode.sh    
+
   # check that docs can still build
   check-docs:
     runs-on: ubuntu-22.04 # latest

.gitignore

@@ -531,3 +531,4 @@ deps/
 
 # API docs are updated automatically by .github/workflows/docs.yml
 docs/
+

README.md

@@ -67,5 +67,13 @@ Please note that on Mac, once a private key is used with a certificate, that cer
 static: certificate has an existing certificate-key pair that was previously imported into the Keychain. Using key from Keychain instead of the one provided.
 ```
 
+## Using With a System-Level Installation of the _awscrt Module or as an Optional Dependency
+
+By default, upon installation if both the wheel is unavailable from PyPi and setup.py cannot build the _awscrt module, installation will still succeed. This is intended to allow the crt to be installed into other libraries or applications as a library without failing its install step if a compiler or any other required build tool is not available. This also allows _awscrt to be loaded at the system level via. operating system package managers as this will cause the loader to look at the system path when it can't find the locally installed module.
+
+````awscrt.crt_wheel_installed()```` will always return without throwing an Exception even if the build itself failed. If this function returns true, the rest of the modules in this package may be used.
+
+To disable this behavior at build time, set ```AWS_CRT_BUILD_STRICT_MODE=ON``` which will cause the install to abort if an error occurs building the wheel.
+
 ## Crash Handler
 You can enable the crash handler by setting the environment variable `AWS_CRT_CRASH_HANDLER=1`. This will print the callstack to `stderr` in the event of a fatal error.

awscrt/__init__.py

@@ -2,6 +2,7 @@
 # SPDX-License-Identifier: Apache-2.0.
 
 from weakref import WeakSet
+from .config import crt_wheel_installed
 
 __all__ = [
     'auth',

awscrt/config.py

@@ -0,0 +1,16 @@
+"""
+Config module which can always be checked regardless of if the CRT was successfully built, installed on system, or not.
+"""
+
+"""
+Returns True if either _awscrt was installed in the local environment or loaded from the system.
+Otherwise returns False indicating that any other functions or modules in this library will also fail.
+"""
+
+
+def crt_wheel_installed():
+    try:
+        import _awscrt
+        return True
+    except Exception:
+        return False

codebuild/cd/manylinux-x64-build.yml

@@ -7,6 +7,7 @@ phases:
   pre_build:
     commands:
       - export CC=gcc
+      - export AWS_CRT_BUILD_STRICT_MODE=ON
       - cd aws-crt-python
       - /opt/python/cp37-cp37m/bin/python ./continuous-delivery/update-version.py
   build:

codebuild/cd/manylinux-x86-build.yml

@@ -7,6 +7,7 @@ phases:
   pre_build:
     commands:
       - export CC=gcc
+      - export AWS_CRT_BUILD_STRICT_MODE=ON
       - cd aws-crt-python
       - /opt/python/cp37-cp37m/bin/python ./continuous-delivery/update-version.py
   build:

codebuild/cd/manylinux1-tee.yml

@@ -7,6 +7,8 @@ phases:
   pre_build:
     commands:
       - export CC=gcc
+      - export AWS_CRT_BUILD_STRICT_MODE=ON
+
   build:
     commands:
       - echo Build started on `date`

codebuild/test-config-on-failure.py

@@ -0,0 +1,8 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0.
+
+import awscrt
+
+print('Is CRT wheel installed? {}', awscrt.crt_wheel_installed())
+## this had better be False since the caller sabotaged the build in some way.
+assert(awscrt.crt_wheel_installed() == False)

codebuild/test-sys-install-mode.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+set -euxo pipefail
+
+# intentionally not pulling the submodules to make the build fail cleanly.
+# git submodule update --init
+
+export AWS_CRT_BUILD_STRICT_MODE=OFF
+python -m venv ./crt-build
+source ./crt-build/bin/activate
+pip install setuptools wheel --upgrade
+pip install -v ./
+python codebuild/test-config-on-failure.py

continuous-delivery/build-wheels-manylinux2014-aarch64.sh

@@ -2,6 +2,8 @@
 #assumes image based on manylinux2014 + extras (cmake3, libcrypto, etc)
 set -ex
 
+export AWS_CRT_BUILD_STRICT_MODE=ON
+
 /opt/python/cp39-cp39/bin/python ./continuous-delivery/update-version.py
 
 /opt/python/cp37-cp37m/bin/python setup.py sdist bdist_wheel

continuous-delivery/build-wheels-manylinux2014-x86_64.sh

@@ -1,6 +1,7 @@
 #!/bin/bash
 #assumes image based on manylinux2014 + extras (cmake3, libcrypto, etc)
 set -ex
+export AWS_CRT_BUILD_STRICT_MODE=ON
 
 /opt/python/cp39-cp39/bin/python ./continuous-delivery/update-version.py
 

continuous-delivery/build-wheels-win64.bat

@@ -1,3 +1,5 @@
+set AWS_CRT_BUILD_STRICT_MODE=ON
+
 "C:\Program Files\Python39\python.exe" continuous-delivery\update-version.py || goto error
 
 "C:\Program Files\Python37\python.exe" setup.py sdist bdist_wheel || goto error

setup.py

@@ -126,6 +126,12 @@ def using_system_libcrypto():
     return os.getenv('AWS_CRT_BUILD_USE_SYSTEM_LIBCRYPTO') == '1'
 
 
+def strict_build_success_mode():
+    strict_mode = os.getenv('AWS_CRT_BUILD_STRICT_MODE')
+    print("Strict-Mode is set to: {}".format(strict_mode))
+    return strict_mode is not None and strict_mode.strip().lower() != 'off'
+
+
 class AwsLib:
     def __init__(self, name, extra_cmake_args=[], libname=None):
         self.name = name
@@ -391,25 +397,52 @@ def _load_version():
         return VERSION_RE.match(fp.read()).group(1)
 
 
-setuptools.setup(
-    name="awscrt",
-    version=_load_version(),
-    license="Apache 2.0",
-    author="Amazon Web Services, Inc",
-    author_email="[email protected]",
-    description="A common runtime for AWS Python projects",
-    long_description=_load_readme(),
-    long_description_content_type='text/markdown',
-    url="https://github.com/awslabs/aws-crt-python",
-    # Note: find_packages() without extra args will end up installing test/
-    packages=setuptools.find_packages(include=['awscrt*']),
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: Apache Software License",
-        "Operating System :: OS Independent",
-    ],
-    python_requires='>=3.7',
-    ext_modules=[awscrt_ext()],
-    cmdclass={'build_ext': awscrt_build_ext, "bdist_wheel": bdist_wheel_abi3},
-    test_suite='test',
-)
+try:
+    setuptools.setup(
+        name="awscrt",
+        version=_load_version(),
+        license="Apache 2.0",
+        author="Amazon Web Services, Inc",
+        author_email="[email protected]",
+        description="A common runtime for AWS Python projects",
+        long_description=_load_readme(),
+        long_description_content_type='text/markdown',
+        url="https://github.com/awslabs/aws-crt-python",
+        # Note: find_packages() without extra args will end up installing test/
+            packages=setuptools.find_packages(include=['awscrt*']),
+            classifiers=[
+                "Programming Language :: Python :: 3",
+                "License :: OSI Approved :: Apache Software License",
+                "Operating System :: OS Independent",
+        ],
+        python_requires='>=3.7',
+        ext_modules=[awscrt_ext()],
+        cmdclass={'build_ext': awscrt_build_ext, "bdist_wheel": bdist_wheel_abi3},
+        test_suite='test',
+    )
+
+except (SystemExit, Exception) as e:
+    if (strict_build_success_mode()):
+        raise e
+
+    # build without the c extension, and allow the system loader to pick it up if/when it's available.
+    # The config module will provide users with a way to check.
+    setuptools.setup(
+        name="awscrt",
+        version=_load_version(),
+        license="Apache 2.0",
+        author="Amazon Web Services, Inc",
+        author_email="[email protected]",
+        description="A common runtime for AWS Python projects",
+        long_description=_load_readme(),
+        long_description_content_type='text/markdown',
+        url="https://github.com/awslabs/aws-crt-python",
+        # Note: find_packages() without extra args will end up installing test/
+            packages=setuptools.find_packages(include=['awscrt*']),
+            classifiers=[
+                "Programming Language :: Python :: 3",
+                "License :: OSI Approved :: Apache Software License",
+                "Operating System :: OS Independent",
+        ],
+        python_requires='>=3.7',
+    )