Changing name_pattern -> pattern (#1976)

Merged PR #1976.

api/resource.rb

@@ -98,11 +98,6 @@ module Properties
       # often used to extract an object from a parent object or a collection.
       attr_reader :nested_query
 
-      # [Optional] If a resource requires a partial URL when sending the name
-      # in the API request, this is the pattern that maps a name to a
-      # partial URL.
-      attr_reader :name_pattern
-
       # ====================
       # IAM Configuration
       # ====================
@@ -159,7 +154,6 @@ def validate
       check :read_verb, type: Symbol, default: :GET, allowed: %i[GET POST]
       check :delete_verb, type: Symbol, default: :DELETE, allowed: %i[POST PUT PATCH DELETE]
       check :update_verb, type: Symbol, default: :PUT, allowed: %i[POST PUT PATCH]
-      check :name_pattern, type: String
 
       check :input, type: :boolean
       check :min_version, type: String

api/type.rb

@@ -60,6 +60,9 @@ module Fields
 
       # Can only be overriden - we should never set this ourselves.
       attr_reader :new_type
+
+      # A pattern that maps expected user input to expected API input.
+      attr_reader :pattern
     end
 
     include Fields
@@ -88,6 +91,7 @@ def validate
                           default: @__resource&.update_verb
 
       check :update_url, type: ::String
+      check :pattern, type: ::String
 
       check_default_value_property
       check_conflicts

products/pubsub/ansible.yaml

@@ -30,18 +30,6 @@ datasources: !ruby/object:Overrides::ResourceOverrides
         does_not_exist: |
           "\"{{resource_name}}\" not in \"{{ results['resources'] | map(attribute='name') | list }}\""
 overrides: !ruby/object:Overrides::ResourceOverrides
-  Topic: !ruby/object:Overrides::Ansible::ResourceOverride
-    transport: !ruby/object:Overrides::Ansible::Transport
-      encoder: encode_request
-      decoder: decode_request
-    provider_helpers:
-      - 'products/pubsub/helpers/python/provider_topic.py'
-  Subscription: !ruby/object:Overrides::Ansible::ResourceOverride
-    transport: !ruby/object:Overrides::Ansible::Transport
-      encoder: encode_request
-      decoder: decode_request
-    provider_helpers:
-      - 'products/pubsub/helpers/python/provider_subscription.py'
 files: !ruby/object:Provider::Config::Files
   compile:
 <%= lines(indent(compile('provider/ansible/product~compile.yaml'), 4)) -%>

products/pubsub/api.yaml

@@ -40,6 +40,7 @@ objects:
         required: true
         description: 'Name of the topic.'
         input: true
+        pattern: 'projects/{{project}}/topics/{{name}}'
       - !ruby/object:Api::Type::String
         name: 'kmsKeyName'
         description: |
@@ -86,6 +87,7 @@ objects:
         description: 'Name of the subscription.'
         required: true
         input: true
+        pattern: 'projects/{{project}}/subscriptions/{{name}}'
       - !ruby/object:Api::Type::ResourceRef
         name: 'topic'
         resource: 'Topic'
@@ -94,6 +96,7 @@ objects:
           A reference to a Topic resource.
         required: true
         input: true
+        pattern: 'projects/{{project}}/topics/{{topic}}'
       - !ruby/object:Api::Type::KeyValuePairs
         name: 'labels'
         description: |

products/sourcerepo/api.yaml

@@ -37,7 +37,6 @@ objects:
         'Official Documentation': 'https://cloud.google.com/source-repositories/'
       api: 'https://cloud.google.com/source-repositories/docs/reference/rest/v1/projects.repos'
     collection_url_key: 'repos'
-    name_pattern: 'projects/{{project}}/repos/{{name}}'
     description: |
       A repository (or repo) is a Git repository storing versioned source content.
     properties:
@@ -48,6 +47,7 @@ objects:
         description: |
           Resource name of the repository, of the form projects/{{project}}/repos/{{repo}}.
           The repo name may contain slashes. eg, projects/myproject/repos/name/with/slash
+        pattern: 'projects/{{project}}/repos/{{name}}'
       - !ruby/object:Api::Type::String
         name: 'url'
         output: true

provider/ansible/request.rb

@@ -62,10 +62,10 @@ def response_output(prop, hash_name, module_name)
         end
       end
 
-      def request_output(prop, hash_name, module_name)
-        # If name + name_pattern, use the function.
-        return "name_partial_to_full(#{hash_name}.get('name'), module.params)" \
-          if prop.name == 'name' && prop.__resource.name_pattern
+      def request_output(prop, hash_name, module_name, allow_pattern = true)
+        # If type has a pattern, use the function.
+        return "#{prop.name.underscore}_pattern(#{request_output(prop, hash_name, module_name, false)}, module)" \
+          if prop.pattern && allow_pattern
 
         return "response.get(#{quote_string(prop.name)})" \
           if prop.is_a? Api::Type::FetchedExternal

templates/ansible/pattern.py.erb

@@ -0,0 +1,26 @@
+<% object.all_user_properties.select(&:pattern).each do |p| -%>
+<%
+  prop_names = p.pattern.scan(/{{([a-z]*)}}/).flatten
+  props = object.all_user_properties.select { |p| prop_names.include?(p.name) }
+-%>
+def <%= p.name.underscore -%>_pattern(name, module):
+    if name is None:
+        return
+
+    regex = r<%= lines(build_url(regex_url(p.pattern))) -%>
+
+    if not re.match(regex, name):
+<% if props.any? { |p| p.is_a?(Api::Type::ResourceRef) } -%>
+        formatted_params = {
+          'project': module.params['project'],
+<% props.each do |url_prop| -%>
+          '<%= url_prop.name -%>': replace_resource_dict(module.params['<%= url_prop.name -%>'], '<%= url_prop.imports -%>'),
+<% end -%>
+        }
+        name = <%= build_url(p.pattern) -%>.format(**formatted_params)
+<% else -%>
+        name = <%= build_url(p.pattern) -%>.format(**module.params)
+<% end -%>
+
+    return name
+<% end -%>

templates/ansible/resource.erb

@@ -32,7 +32,7 @@ import json
 <%
   imports = object.imports || []
   imports << 'time' if object.async
-  imports << 're' if !readonly_selflink_rrefs.empty? || object.name_pattern
+  imports << 're' if !readonly_selflink_rrefs.empty? || object.all_user_properties.any?(&:pattern)
 -%>
 <%= lines(imports.sort.uniq.map { |i| "import #{i}" }) -%>
 
@@ -419,8 +419,8 @@ def is_different(module, response):
 # This is for doing comparisons with Ansible's current parameters.
 def response_to_hash(module, response):
     return <%= lines(python_literal(response_properties(object.properties), use_hash_brackets: true)) -%>
-<% if object.name_pattern -%>
-<%= lines(compile('templates/ansible/name_pattern.py.erb')) -%>
+<% if object.all_user_properties.any?(&:pattern) -%>
+<%= lines(compile('templates/ansible/pattern.py.erb')) -%>
 <% end -%>
 <% readonly_selflink_rrefs.each do |resource| -%>