Merge branch '354193-static-integration-dsl-app-models-integrations-datadog-rb' into 'master'

Static Integration DSL: app/models/integrations/datadog.rb

See merge request !100926



Merged-by: Allen Cook <acook@gitlab.com>
Approved-by: Omar Qunsul <oqunsul@gitlab.com>
Approved-by: Allen Cook <acook@gitlab.com>
Co-authored-by: bmarjanovic <bmarjanovic@gitlab.com>

app/models/integrations/datadog.rb

@@ -15,7 +15,77 @@ class Datadog < Integration
 
     TAG_KEY_VALUE_RE = %r{\A [\w-]+ : .*\S.* \z}x.freeze
 
-    prop_accessor :datadog_site, :api_url, :api_key, :datadog_service, :datadog_env, :datadog_tags
+    field :datadog_site,
+      placeholder: DEFAULT_DOMAIN,
+      help: -> do
+        ERB::Util.html_escape(
+          s_('DatadogIntegration|The Datadog site to send data to. To send data to the EU site, use %{codeOpen}datadoghq.eu%{codeClose}.')
+        ) % {
+          codeOpen: '<code>'.html_safe,
+          codeClose: '</code>'.html_safe
+        }
+      end
+
+    field :api_url,
+      exposes_secrets: true,
+      title: -> { s_('DatadogIntegration|API URL') },
+      help: -> { s_('DatadogIntegration|(Advanced) The full URL for your Datadog site.') }
+
+    field :api_key,
+      type: 'password',
+      title: -> { _('API key') },
+      non_empty_password_title: -> { s_('ProjectService|Enter new API key') },
+      non_empty_password_help: -> { s_('ProjectService|Leave blank to use your current API key') },
+      help: -> do
+        ERB::Util.html_escape(
+          s_('DatadogIntegration|%{linkOpen}API key%{linkClose} used for authentication with Datadog.')
+        ) % {
+          linkOpen: %Q{<a href="#{URL_API_KEYS_DOCS}" target="_blank" rel="noopener noreferrer">}.html_safe,
+          linkClose: '</a>'.html_safe
+        }
+      end,
+      required: true
+
+    field :archive_trace_events,
+      storage: :attribute,
+      type: 'checkbox',
+      title: -> { s_('Logs') },
+      checkbox_label: -> { s_('Enable logs collection') },
+      help: -> { s_('When enabled, job logs are collected by Datadog and displayed along with pipeline execution traces.') }
+
+    field :datadog_service,
+      title: -> { s_('DatadogIntegration|Service') },
+      placeholder: 'gitlab-ci',
+      help: -> { s_('DatadogIntegration|Tag all data from this GitLab instance in Datadog. Useful when managing several self-managed deployments.') }
+
+    field :datadog_env,
+      title: -> { s_('DatadogIntegration|Environment') },
+      placeholder: 'ci',
+      help: -> do
+        ERB::Util.html_escape(
+          s_('DatadogIntegration|For self-managed deployments, set the %{codeOpen}env%{codeClose} tag for all the data sent to Datadog. %{linkOpen}How do I use tags?%{linkClose}')
+        ) % {
+          codeOpen: '<code>'.html_safe,
+          codeClose: '</code>'.html_safe,
+          linkOpen: '<a href="https://docs.datadoghq.com/getting_started/tagging/#using-tags" target="_blank" rel="noopener noreferrer">'.html_safe,
+          linkClose: '</a>'.html_safe
+        }
+      end
+
+    field :datadog_tags,
+      type: 'textarea',
+      title: -> { s_('DatadogIntegration|Tags') },
+      placeholder: "tag:value\nanother_tag:value",
+      help: -> do
+        ERB::Util.html_escape(
+          s_('DatadogIntegration|Custom tags in Datadog. Enter one tag per line in the %{codeOpen}key:value%{codeClose} format. %{linkOpen}How do I use tags?%{linkClose}')
+        ) % {
+          codeOpen: '<code>'.html_safe,
+          codeClose: '</code>'.html_safe,
+          linkOpen: '<a href="https://docs.datadoghq.com/getting_started/tagging/#using-tags" target="_blank" rel="noopener noreferrer">'.html_safe,
+          linkClose: '</a>'.html_safe
+        }
+      end
 
     before_validation :strip_properties
 
@@ -68,87 +138,6 @@ def self.to_param
       'datadog'
     end
 
-    def fields
-      [
-        {
-          type: 'text',
-          name: 'datadog_site',
-          placeholder: DEFAULT_DOMAIN,
-          help: ERB::Util.html_escape(
-            s_('DatadogIntegration|The Datadog site to send data to. To send data to the EU site, use %{codeOpen}datadoghq.eu%{codeClose}.')
-          ) % {
-            codeOpen: '<code>'.html_safe,
-            codeClose: '</code>'.html_safe
-          },
-          required: false
-        },
-        {
-          type: 'text',
-          name: 'api_url',
-          title: s_('DatadogIntegration|API URL'),
-          help: s_('DatadogIntegration|(Advanced) The full URL for your Datadog site.'),
-          required: false
-        },
-        {
-          type: 'password',
-          name: 'api_key',
-          title: _('API key'),
-          non_empty_password_title: s_('ProjectService|Enter new API key'),
-          non_empty_password_help: s_('ProjectService|Leave blank to use your current API key'),
-          help: ERB::Util.html_escape(
-            s_('DatadogIntegration|%{linkOpen}API key%{linkClose} used for authentication with Datadog.')
-          ) % {
-            linkOpen: %Q{<a href="#{URL_API_KEYS_DOCS}" target="_blank" rel="noopener noreferrer">}.html_safe,
-            linkClose: '</a>'.html_safe
-          },
-          required: true
-        },
-        {
-          type: 'checkbox',
-          name: 'archive_trace_events',
-          title: s_('Logs'),
-          checkbox_label: s_('Enable logs collection'),
-          help: s_('When enabled, job logs are collected by Datadog and displayed along with pipeline execution traces.'),
-          required: false
-        },
-        {
-          type: 'text',
-          name: 'datadog_service',
-          title: s_('DatadogIntegration|Service'),
-          placeholder: 'gitlab-ci',
-          help: s_('DatadogIntegration|Tag all data from this GitLab instance in Datadog. Useful when managing several self-managed deployments.')
-        },
-        {
-          type: 'text',
-          name: 'datadog_env',
-          title: s_('DatadogIntegration|Environment'),
-          placeholder: 'ci',
-          help: ERB::Util.html_escape(
-            s_('DatadogIntegration|For self-managed deployments, set the %{codeOpen}env%{codeClose} tag for all the data sent to Datadog. %{linkOpen}How do I use tags?%{linkClose}')
-          ) % {
-            codeOpen: '<code>'.html_safe,
-            codeClose: '</code>'.html_safe,
-            linkOpen: '<a href="https://docs.datadoghq.com/getting_started/tagging/#using-tags" target="_blank" rel="noopener noreferrer">'.html_safe,
-            linkClose: '</a>'.html_safe
-          }
-        },
-        {
-          type: 'textarea',
-          name: 'datadog_tags',
-          title: s_('DatadogIntegration|Tags'),
-          placeholder: "tag:value\nanother_tag:value",
-          help: ERB::Util.html_escape(
-            s_('DatadogIntegration|Custom tags in Datadog. Enter one tag per line in the %{codeOpen}key:value%{codeClose} format. %{linkOpen}How do I use tags?%{linkClose}')
-          ) % {
-            codeOpen: '<code>'.html_safe,
-            codeClose: '</code>'.html_safe,
-            linkOpen: '<a href="https://docs.datadoghq.com/getting_started/tagging/#using-tags" target="_blank" rel="noopener noreferrer">'.html_safe,
-            linkClose: '</a>'.html_safe
-          }
-        }
-      ]
-    end
-
     override :hook_url
     def hook_url
       url = api_url.presence || sprintf(URL_TEMPLATE, datadog_domain: datadog_domain)

spec/models/integrations/datadog_spec.rb

@@ -47,6 +47,10 @@
     Gitlab::DataBuilder::ArchiveTrace.build(build)
   end
 
+  it_behaves_like Integrations::ResetSecretFields do
+    let(:integration) { instance }
+  end
+
   it_behaves_like Integrations::HasWebHook do
     let(:integration) { instance }
     let(:hook_url) { "#{described_class::URL_TEMPLATE % { datadog_domain: dd_site }}?dd-api-key={api_key}&env=#{dd_env}&service=#{dd_service}" }