Bug fixes for gcp_compute_target_https_proxy (#42824)

lib/ansible/modules/cloud/google/gcp_compute_target_https_proxy.py

@@ -60,6 +60,16 @@ options:
               must be a dash, lowercase letter, or digit, except the last character, which cannot
               be a dash.
         required: true
+    quic_override:
+        description:
+            - Specifies the QUIC override policy for this resource. This determines whether the
+              load balancer will attempt to negotiate QUIC with clients or not. Can specify one
+              of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy with no
+              user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent
+              to specifying NONE.
+        required: false
+        version_added: 2.7
+        choices: ['NONE', 'ENABLE', 'DISABLE']
     ssl_certificates:
         description:
             - A list of SslCertificate resources that are used to authenticate connections between
@@ -67,27 +77,28 @@ options:
         required: true
     url_map:
         description:
-            - A reference to UrlMap resource.
+            - A reference to the UrlMap resource that defines the mapping from URL to the BackendService.
         required: true
 extends_documentation_fragment: gcp
+notes:
+    - "API Reference: U(https://cloud.google.com/compute/docs/reference/latest/targetHttpsProxies)"
+    - "Official Documentation: U(https://cloud.google.com/compute/docs/load-balancing/http/target-proxies)"
 '''
 
 EXAMPLES = '''
 - name: create a instance group
   gcp_compute_instance_group:
-      name: 'instancegroup-targethttpsproxy'
+      name: "instancegroup-targethttpsproxy"
-      zone: 'us-central1-a'
+      zone: us-central1-a
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: present
   register: instancegroup
 
 - name: create a http health check
   gcp_compute_http_health_check:
-      name: 'httphealthcheck-targethttpsproxy'
+      name: "httphealthcheck-targethttpsproxy"
       healthy_threshold: 10
       port: 8080
       timeout_sec: 2
@@ -95,14 +106,12 @@ EXAMPLES = '''
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: present
   register: healthcheck
 
 - name: create a backend service
   gcp_compute_backend_service:
-      name: 'backendservice-targethttpsproxy'
+      name: "backendservice-targethttpsproxy"
       backends:
       - group: "{{ instancegroup }}"
       health_checks:
@@ -111,28 +120,23 @@ EXAMPLES = '''
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: present
   register: backendservice
 
 - name: create a url map
   gcp_compute_url_map:
-      name: 'urlmap-targethttpsproxy'
+      name: "urlmap-targethttpsproxy"
       default_service: "{{ backendservice }}"
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: present
   register: urlmap
 
 - name: create a ssl certificate
   gcp_compute_ssl_certificate:
-      name: 'sslcert-targethttpsproxy'
+      name: "sslcert-targethttpsproxy"
-      description: |
+      description: A certificate for testing. Do not use this certificate in production
-        "A certificate for testing. Do not use this certificate in production"
       certificate: |
         -----BEGIN CERTIFICATE-----
         MIICqjCCAk+gAwIBAgIJAIuJ+0352Kq4MAoGCCqGSM49BAMCMIGwMQswCQYDVQQG
@@ -160,22 +164,18 @@ EXAMPLES = '''
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: present
   register: sslcert
 
 - name: create a target https proxy
   gcp_compute_target_https_proxy:
-      name: testObject
+      name: "test_object"
       ssl_certificates:
       - "{{ sslcert }}"
       url_map: "{{ urlmap }}"
-      project: testProject
+      project: "test_project"
-      auth_kind: service_account
+      auth_kind: "service_account"
-      service_account_file: /tmp/auth.pem
+      service_account_file: "/tmp/auth.pem"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: present
 '''
 
@@ -205,6 +205,15 @@ RETURN = '''
               be a dash.
         returned: success
         type: str
+    quic_override:
+        description:
+            - Specifies the QUIC override policy for this resource. This determines whether the
+              load balancer will attempt to negotiate QUIC with clients or not. Can specify one
+              of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy with no
+              user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent
+              to specifying NONE.
+        returned: success
+        type: str
     ssl_certificates:
         description:
             - A list of SslCertificate resources that are used to authenticate connections between
@@ -213,7 +222,7 @@ RETURN = '''
         type: list
     url_map:
         description:
-            - A reference to UrlMap resource.
+            - A reference to the UrlMap resource that defines the mapping from URL to the BackendService.
         returned: success
         type: dict
 '''
@@ -239,11 +248,15 @@ def main():
             state=dict(default='present', choices=['present', 'absent'], type='str'),
             description=dict(type='str'),
             name=dict(required=True, type='str'),
+            quic_override=dict(type='str', choices=['NONE', 'ENABLE', 'DISABLE']),
             ssl_certificates=dict(required=True, type='list', elements='dict'),
             url_map=dict(required=True, type='dict')
         )
     )
 
+    if not module.params['scopes']:
+        module.params['scopes'] = ['https://www.googleapis.com/auth/compute']
+
     state = module.params['state']
     kind = 'compute#targetHttpsProxy'
 
@@ -291,6 +304,7 @@ def resource_to_request(module):
         u'kind': 'compute#targetHttpsProxy',
         u'description': module.params.get('description'),
         u'name': module.params.get('name'),
+        u'quicOverride': module.params.get('quic_override'),
         u'sslCertificates': replace_resource_dict(module.params.get('ssl_certificates', []), 'selfLink'),
         u'urlMap': replace_resource_dict(module.params.get(u'url_map', {}), 'selfLink')
     }
@@ -361,9 +375,10 @@ def is_different(module, response):
 def response_to_hash(module, response):
     return {
         u'creationTimestamp': response.get(u'creationTimestamp'),
-        u'description': response.get(u'description'),
+        u'description': module.params.get('description'),
         u'id': response.get(u'id'),
-        u'name': response.get(u'name'),
+        u'name': module.params.get('name'),
+        u'quicOverride': response.get(u'quicOverride'),
         u'sslCertificates': response.get(u'sslCertificates'),
         u'urlMap': response.get(u'urlMap')
     }
@@ -381,7 +396,7 @@ def async_op_url(module, extra_data=None):
 def wait_for_operation(module, response):
     op_result = return_if_object(module, response, 'compute#operation')
     if op_result is None:
-        return None
+        return {}
     status = navigate_hash(op_result, ['status'])
     wait_done = wait_for_completion(status, op_result, module)
     return fetch_resource(module, navigate_hash(wait_done, ['targetLink']), 'compute#targetHttpsProxy')

test/integration/targets/gcp_compute_target_https_proxy/tasks/main.yml

@@ -15,18 +15,16 @@
 # Pre-test setup
 - name: create a instance group
   gcp_compute_instance_group:
-      name: 'instancegroup-targethttpsproxy'
+      name: "instancegroup-targethttpsproxy"
-      zone: 'us-central1-a'
+      zone: us-central1-a
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: present
   register: instancegroup
 - name: create a http health check
   gcp_compute_http_health_check:
-      name: 'httphealthcheck-targethttpsproxy'
+      name: "httphealthcheck-targethttpsproxy"
       healthy_threshold: 10
       port: 8080
       timeout_sec: 2
@@ -34,13 +32,11 @@
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: present
   register: healthcheck
 - name: create a backend service
   gcp_compute_backend_service:
-      name: 'backendservice-targethttpsproxy'
+      name: "backendservice-targethttpsproxy"
       backends:
       - group: "{{ instancegroup }}"
       health_checks:
@@ -49,26 +45,21 @@
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: present
   register: backendservice
 - name: create a url map
   gcp_compute_url_map:
-      name: 'urlmap-targethttpsproxy'
+      name: "urlmap-targethttpsproxy"
       default_service: "{{ backendservice }}"
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: present
   register: urlmap
 - name: create a ssl certificate
   gcp_compute_ssl_certificate:
-      name: 'sslcert-targethttpsproxy'
+      name: "sslcert-targethttpsproxy"
-      description: |
+      description: A certificate for testing. Do not use this certificate in production
-        "A certificate for testing. Do not use this certificate in production"
       certificate: |
         -----BEGIN CERTIFICATE-----
         MIICqjCCAk+gAwIBAgIJAIuJ+0352Kq4MAoGCCqGSM49BAMCMIGwMQswCQYDVQQG
@@ -96,8 +87,6 @@
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: present
   register: sslcert
 - name: delete a target https proxy
@@ -109,8 +98,6 @@
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: absent
 #----------------------------------------------------------
 - name: create a target https proxy
@@ -122,8 +109,6 @@
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: present
   register: result
 - name: assert changed is true
@@ -132,13 +117,19 @@
       - result.changed == true
       - "result.kind == 'compute#targetHttpsProxy'"
 - name: verify that target_https_proxy was created
-  shell: |
+  gcp_compute_target_https_proxy_facts:
-    gcloud compute target-https-proxies describe  --project="{{ gcp_project}}"  "{{ resource_name }}"
+      filters:
+         - name = {{ resource_name }}
+      project: "{{ gcp_project }}"
+      auth_kind: "{{ gcp_cred_kind }}"
+      service_account_file: "{{ gcp_cred_file }}"
+      scopes:
+        - https://www.googleapis.com/auth/compute
   register: results
 - name: verify that command succeeded
   assert:
     that:
-      - results.rc == 0
+      - results['items'] | length == 1
 # ----------------------------------------------------------------------------
 - name: create a target https proxy that already exists
   gcp_compute_target_https_proxy:
@@ -149,8 +140,6 @@
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: present
   register: result
 - name: assert changed is false
@@ -168,8 +157,6 @@
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: absent
   register: result
 - name: assert changed is true
@@ -178,15 +165,19 @@
       - result.changed == true
       - result.has_key('kind') == False
 - name: verify that target_https_proxy was deleted
-  shell: |
+  gcp_compute_target_https_proxy_facts:
-    gcloud compute target-https-proxies describe  --project="{{ gcp_project}}"  "{{ resource_name }}"
+      filters:
+         - name = {{ resource_name }}
+      project: "{{ gcp_project }}"
+      auth_kind: "{{ gcp_cred_kind }}"
+      service_account_file: "{{ gcp_cred_file }}"
+      scopes:
+        - https://www.googleapis.com/auth/compute
   register: results
-  failed_when: results.rc == 0
 - name: verify that command succeeded
   assert:
     that:
-      - results.rc == 1
+      - results['items'] | length == 0
-      - "\"'projects/{{ gcp_project }}/global/targetHttpsProxies/{{ resource_name }}' was not found\" in results.stderr"
 # ----------------------------------------------------------------------------
 - name: delete a target https proxy that does not exist
   gcp_compute_target_https_proxy:
@@ -197,8 +188,6 @@
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: absent
   register: result
 - name: assert changed is false
@@ -210,9 +199,8 @@
 # Post-test teardown
 - name: delete a ssl certificate
   gcp_compute_ssl_certificate:
-      name: 'sslcert-targethttpsproxy'
+      name: "sslcert-targethttpsproxy"
-      description: |
+      description: A certificate for testing. Do not use this certificate in production
-        "A certificate for testing. Do not use this certificate in production"
       certificate: |
         -----BEGIN CERTIFICATE-----
         MIICqjCCAk+gAwIBAgIJAIuJ+0352Kq4MAoGCCqGSM49BAMCMIGwMQswCQYDVQQG
@@ -240,24 +228,20 @@
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: absent
   register: sslcert
 - name: delete a url map
   gcp_compute_url_map:
-      name: 'urlmap-targethttpsproxy'
+      name: "urlmap-targethttpsproxy"
       default_service: "{{ backendservice }}"
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: absent
   register: urlmap
 - name: delete a backend service
   gcp_compute_backend_service:
-      name: 'backendservice-targethttpsproxy'
+      name: "backendservice-targethttpsproxy"
       backends:
       - group: "{{ instancegroup }}"
       health_checks:
@@ -266,13 +250,11 @@
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: absent
   register: backendservice
 - name: delete a http health check
   gcp_compute_http_health_check:
-      name: 'httphealthcheck-targethttpsproxy'
+      name: "httphealthcheck-targethttpsproxy"
       healthy_threshold: 10
       port: 8080
       timeout_sec: 2
@@ -280,18 +262,14 @@
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: absent
   register: healthcheck
 - name: delete a instance group
   gcp_compute_instance_group:
-      name: 'instancegroup-targethttpsproxy'
+      name: "instancegroup-targethttpsproxy"
-      zone: 'us-central1-a'
+      zone: us-central1-a
       project: "{{ gcp_project }}"
       auth_kind: "{{ gcp_cred_kind }}"
       service_account_file: "{{ gcp_cred_file }}"
-      scopes:
-        - https://www.googleapis.com/auth/compute
       state: absent
   register: instancegroup