fix: add system tests and cert/key

googleapis · Apr 16, 2020 · ebb8b36 · ebb8b36
1 parent 5f4c300
commit ebb8b36
Show file tree

Hide file tree

Showing 5 changed files with 307 additions and 28 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -91,6 +91,17 @@ workflows:
           filters:
             tags:
               only: /^\d+\.\d+\.\d+$/
+      - showcase-mtls:
+          requires:
+            - docs
+            - mypy
+            - showcase-unit-3.6
+            - showcase-unit-3.7
+            - showcase-unit-3.8
+            - showcase-mypy
+          filters:
+            tags:
+              only: /^\d+\.\d+\.\d+$/
       - showcase-alternative-templates:
           requires:
             - docs
@@ -102,6 +113,17 @@ workflows:
           filters:
             tags:
               only: /^\d+\.\d+\.\d+$/
+      - showcase-mtls-alternative-templates:
+          requires:
+            - docs
+            - mypy
+            - showcase-unit-alternative-templates-3.6
+            - showcase-unit-alternative-templates-3.7
+            - showcase-unit-alternative-templates-3.8
+            - showcase-mypy-alternative-templates
+          filters:
+            tags:
+              only: /^\d+\.\d+\.\d+$/
       - docs:
           filters:
             tags:
@@ -207,7 +229,7 @@ jobs:
   showcase:
     docker:
       - image: python:3.8-slim
-      - image: gcr.io/gapic-images/gapic-showcase:0.6.1
+      - image: gcr.io/gapic-images/gapic-showcase:0.8.1
     steps:
       - checkout
       - run:
@@ -229,10 +251,51 @@ jobs:
       - run:
           name: Run showcase tests.
           command: nox -s showcase
+  showcase-mtls:
+    working_directory: /tmp/workspace
+    docker:
+      - image: python:3.8-slim
+    steps:
+      - checkout
+      - run:
+          name: Install system dependencies.
+          command: |
+            apt-get update
+            apt-get install -y curl pandoc unzip
+      - run:
+          name: Install nox.
+          command: pip install nox
+      - run:
+          name: Install protoc 3.7.1.
+          command: |
+            mkdir -p /usr/src/protoc/
+            curl --location https://github.com/google/protobuf/releases/download/v3.7.1/protoc-3.7.1-linux-x86_64.zip --output /usr/src/protoc/protoc-3.7.1.zip
+            cd /usr/src/protoc/
+            unzip protoc-3.7.1.zip
+            ln -s /usr/src/protoc/bin/protoc /usr/local/bin/protoc
+      - run:
+          name: Run showcase tests.
+          command:  |
+            mkdir gapic_showcase
+            cd gapic_showcase
+            curl -sSL https://github.com/googleapis/gapic-showcase/releases/download/v0.8.1/gapic-showcase-0.8.1-linux-amd64.tar.gz | tar xz
+            ./gapic-showcase run --mtls-ca-cert=/tmp/workspace/tests/cert/mtls.crt --mtls-cert=/tmp/workspace/tests/cert/mtls.crt --mtls-key=/tmp/workspace/tests/cert/mtls.key &
+            showcase_pid=$!
+
+            cleanup() {
+              echo "kill showcase server"
+            	kill $showcase_pid
+            	# Wait for the process to die, but don't report error from the kill.
+            	wait $showcase_pid || exit $exit_code
+            }
+            trap cleanup EXIT
+
+            cd ..
+            nox -s showcase_mtls
   showcase-alternative-templates:
     docker:
       - image: python:3.8-slim
-      - image: gcr.io/gapic-images/gapic-showcase:0.6.1
+      - image: gcr.io/gapic-images/gapic-showcase:0.8.1
     steps:
       - checkout
       - run:
@@ -254,6 +317,47 @@ jobs:
       - run:
           name: Run showcase tests.
           command: nox -s showcase_alternative_templates
+  showcase-mtls-alternative-templates:
+    working_directory: /tmp/workspace
+    docker:
+      - image: python:3.8-slim
+    steps:
+      - checkout
+      - run:
+          name: Install system dependencies.
+          command: |
+            apt-get update
+            apt-get install -y curl pandoc unzip
+      - run:
+          name: Install nox.
+          command: pip install nox
+      - run:
+          name: Install protoc 3.7.1.
+          command: |
+            mkdir -p /usr/src/protoc/
+            curl --location https://github.com/google/protobuf/releases/download/v3.7.1/protoc-3.7.1-linux-x86_64.zip --output /usr/src/protoc/protoc-3.7.1.zip
+            cd /usr/src/protoc/
+            unzip protoc-3.7.1.zip
+            ln -s /usr/src/protoc/bin/protoc /usr/local/bin/protoc
+      - run:
+          name: Run showcase tests.
+          command:  |
+            mkdir gapic_showcase
+            cd gapic_showcase
+            curl -sSL https://github.com/googleapis/gapic-showcase/releases/download/v0.8.1/gapic-showcase-0.8.1-linux-amd64.tar.gz | tar xz
+            ./gapic-showcase run --mtls-ca-cert=/tmp/workspace/tests/cert/mtls.crt --mtls-cert=/tmp/workspace/tests/cert/mtls.crt --mtls-key=/tmp/workspace/tests/cert/mtls.key &
+            showcase_pid=$!
+
+            cleanup() {
+              echo "kill showcase server"
+            	kill $showcase_pid
+            	# Wait for the process to die, but don't report error from the kill.
+            	wait $showcase_pid || exit $exit_code
+            }
+            trap cleanup EXIT
+
+            cd ..
+            nox -s showcase_mtls_alternative_templates
   showcase-unit-3.6:
     docker:
       - image: python:3.6-slim

diff --git a/noxfile.py b/noxfile.py
@@ -67,6 +67,7 @@ def showcase(
         session.log('-' * 70)
 
     # Install pytest and gapic-generator-python
+    session.install('mock')
     session.install('pytest')
     session.install('-e', '.')
 
@@ -103,12 +104,73 @@ def showcase(
     )
 
 
+@nox.session(python='3.8')
+def showcase_mtls(
+    session,
+    templates='DEFAULT',
+    other_opts: typing.Iterable[str] = (),
+):
+    """Run the Showcase mtls test suite."""
+
+    # Try to make it clear if Showcase is not running, so that
+    # people do not end up with tons of difficult-to-debug failures over
+    # an obvious problem.
+    if not os.environ.get('CIRCLECI'):
+        session.log('-' * 70)
+        session.log('Note: Showcase must be running for these tests to work.')
+        session.log('See https://github.com/googleapis/gapic-showcase')
+        session.log('-' * 70)
+
+    # Install pytest and gapic-generator-python
+    session.install('mock')
+    session.install('pytest')
+    session.install('-e', '.')
+
+    # Install a client library for Showcase.
+    with tempfile.TemporaryDirectory() as tmp_dir:
+        # Download the Showcase descriptor.
+        session.run(
+            'curl', 'https://github.com/googleapis/gapic-showcase/releases/'
+                    f'download/v{showcase_version}/'
+                    f'gapic-showcase-{showcase_version}.desc',
+            '-L', '--output', path.join(tmp_dir, 'showcase.desc'),
+            external=True,
+            silent=True,
+        )
+
+        # Write out a client library for Showcase.
+        template_opt = f'python-gapic-templates={templates}'
+        opts = f'--python_gapic_opt={template_opt}'
+        opts += ','.join(other_opts + ('lazy-import',))
+        session.run(
+            'protoc',
+            f'--descriptor_set_in={tmp_dir}{path.sep}showcase.desc',
+            f'--python_gapic_out={tmp_dir}',
+            'google/showcase/v1beta1/echo.proto',
+            'google/showcase/v1beta1/identity.proto',
+            external=True,
+        )
+
+        # Install the library.
+        session.install(tmp_dir)
+
+    session.run(
+        'py.test', '--quiet', '--mtls', *(session.posargs or [path.join('tests', 'system')])
+    )
+
+
 @nox.session(python='3.8')
 def showcase_alternative_templates(session):
     templates = path.join(path.dirname(__file__), 'gapic', 'ads-templates')
     showcase(session, templates=templates, other_opts=('old-naming',))
 
 
+@nox.session(python='3.8')
+def showcase_mtls_alternative_templates(session):
+    templates = path.join(path.dirname(__file__), 'gapic', 'ads-templates')
+    showcase_mtls(session, templates=templates, other_opts=('old-naming',))
+
+
 @nox.session(python=['3.6', '3.7', '3.8'])
 def showcase_unit(
     session,

diff --git a/tests/cert/mtls.crt b/tests/cert/mtls.crt
@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDbDCCAlSgAwIBAgIJALV2ZblaPmp2MA0GCSqGSIb3DQEBCwUAMEoxCzAJBgNV
+BAYTAlVTMRMwEQYDVQQIDApTb21lLVN0YXRlMRIwEAYDVQQKDAlsb2NhbGhvc3Qx
+EjAQBgNVBAMMCWxvY2FsaG9zdDAgFw0yMDA0MTUwNjE2NDRaGA8zMDE5MDgxNzA2
+MTY0NFowSjELMAkGA1UEBhMCVVMxEzARBgNVBAgMClNvbWUtU3RhdGUxEjAQBgNV
+BAoMCWxvY2FsaG9zdDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0B
+AQEFAAOCAQ8AMIIBCgKCAQEAxOcBZ3f679mn90KA7RzBTr8zwKqcI/7OcJ2GooZh
+JvZpD/M6TqhopIgf29O082QrJZLo29lSyVtufTalmg9U4lNDFPAm/BvX7ydaHSdN
+FZzn1BInhqvtBXMOy1nGegr4QtgdFSlShuhT8Lo3XxMERP+/Nhyv8wPEy+MTxym3
+WxbJPPhsmQQ42gIgRyqWHVbj6vpCRHp7l81Kh+/wcbC+C/5ARw0vgPIDAAk9iWBU
+TJS1q0ghUZyITeafw6fMVqgMAT7vM2WZzfOeOsLunm3t4DQCsJxFrvKQkgi3loXa
+MueqepuF0UZIChg/o4k6ecJ2qxD7ad04UsvX1pRBvKKvNQIDAQABo1MwUTAdBgNV
+HQ4EFgQUwqm+cCEtQM+Vu05zLforb4IssBswHwYDVR0jBBgwFoAUwqm+cCEtQM+V
+u05zLforb4IssBswDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEA
+oqO8ZN92cWNB0TAd9WyPfGz1szn2pRWgOMomEMkry4ESGhOKivrY5CcyMZddfh2a
+qmbB0i/pw6/YUVHuhVN369xB/L5pi5UJC+nqdA8p2zSuRidH7cUIxhXTCU6wr8H/
+dZV/tYXmvyRoB7tHh3Jzy1/BhowvCWkBNfAGuFRGb+nlJ2i3Nu9bej32ql4U3zPF
+TuOtYH4hSlGa1jBjFp8XM1RiwSA4EkZ79J8Vb0h8IFeMPxobAUiBPLfU+jbmmC90
+aaZI2IhjUUkfUvatLL8brGeo9KdzepaXhQj62OUOyz1ZmAox3TPZNOXgv8+9d8hG
+q5TMYoc9yklgNpo+VPtbug==
+-----END CERTIFICATE-----
diff --git a/tests/cert/mtls.key b/tests/cert/mtls.key
@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDE5wFnd/rv2af3
+QoDtHMFOvzPAqpwj/s5wnYaihmEm9mkP8zpOqGikiB/b07TzZCslkujb2VLJW259
+NqWaD1TiU0MU8Cb8G9fvJ1odJ00VnOfUEieGq+0Fcw7LWcZ6CvhC2B0VKVKG6FPw
+ujdfEwRE/782HK/zA8TL4xPHKbdbFsk8+GyZBDjaAiBHKpYdVuPq+kJEenuXzUqH
+7/BxsL4L/kBHDS+A8gMACT2JYFRMlLWrSCFRnIhN5p/Dp8xWqAwBPu8zZZnN8546
+wu6ebe3gNAKwnEWu8pCSCLeWhdoy56p6m4XRRkgKGD+jiTp5wnarEPtp3ThSy9fW
+lEG8oq81AgMBAAECggEAQma4xYDjogEfsLW/rra0xe6a8E1YzJbAXZ/x6Fsy5iXQ
+9m0K673FVD8Hp2V0r2PHXSt21bUrQvZPg3BrVlH3ST/U7nmyW/Cz2FXIAO7hAvng
+AFeC9tqB2wWbJp6G3V9Xq4sf+6PszcwJirPxumE6Xl50yDXSbDyIIE3avJ5n1BJ6
+S9RrjABVzIQ21/7mjgt8kkz4n7bOuHHkYH24D/NgTjcec/OXU/zcQlHDb3a0MRsG
+GjYAWVRM5mg/BJ7Tq0zkibrubWv+Ns2fU9lj3FNVSMpuCqFidwkMcVgreOsdTFLo
+GnoZCsHRTsSZNOs5RkFvEKcCzpyAjeNC5aOqpJOYIQKBgQDw0hJe9LhZu2TB0uqr
+E1X4a5UdrMolSBSx6hWpSPpSZR4TfVv1nvMG8joiQBt+JJRLUqiMMjLVPvMeM7I7
+XtzgVCcSetIQoyXWOmSBi1aT8m8BJpyWTzTLimiENtPwgFZLOFkiBNuXVjI9cWD6
+9iLHQ766WrBusFJ8VtRpNUghGQKBgQDRUEK24/KFa84PfTTZjJGcJMj9qkNkarPr
+KmD1+e9BmRkt/d/ApX6vtQMVS4mfGoQr989VYGkDbQorYo4RMT1fAW/A6tG94nf+
+okUzhWFZZP+kXPtIR11Du9R0XbUbehvp5L72A8ZBLEuR+83N6Ywv3DHcuudYMi1c
+1Q2TypF2fQKBgHtzdS9wTEDTq6cgtGPWma+rltmLhmTuOo2p7kjFvG0YoP5kuQuE
+3Bine92q920G225xhS25Xg2rI35MCgYdbyUgfpcelykoOXFEpdky0MMu+HCilosH
+N41P+pwsbyFO6O3OiQLDcr511XNh99Eu9E0qEU/+xYs4oFBVQrZcNgmhAoGBALqW
+58IN1gYmIh0gqlo8uxkMmbe3bjg3/odm0eS0lxpNFmsvY6ViYlrT7Bmxqs8QXj6r
+vEIJndOWAnjGdIrS8DifGTZKngq9teZiVXomLq/4HwQwdzjplTRqXmwVlPsXkYah
+ibHZj4RNrlhGtiIXTgbkLfbtDopKwLF+o4naDG4pAoGBAMFWBV5EDu6V9lSKUojA
+/V1PmbVU5qcaEpE6N6d3M0rk6u486JGwgzn9mcSBktqKJmYXIZwVHJYbJc/v8HNt
+rjHp7WkDjQF05QQm7hWjPAN8RXRSbVDUQ9kG/uN6gTbjeH0qqmlFfdBoE26wO97N
+Q5o2l+4C3QlHrO5ifRFvh3hX
+-----END PRIVATE KEY-----