Merge branch '15398-expiration-policies-update-api' into 'master'

Allow updates to container_expiration_policy in the project API

See merge request gitlab-org/gitlab!22180

changelogs/unreleased/15398-expiration-policies-update-api.yml

+---
+title: Container expiration policies can be updated with the project api
+merge_request: 22180
+author:
+type: added

doc/api/projects.md

@@ -761,6 +761,14 @@ GET /projects/:id
   "snippets_enabled": false,
   "resolve_outdated_diff_discussions": false,
   "container_registry_enabled": false,
+  "container_expiration_policy": {
+    "cadence": "7d",
+    "enabled": false,
+    "keep_n": null,
+    "older_than": null,
+    "name_regex": null,
+    "next_run_at": "2020-01-07T21:42:58.658Z"
+  },
   "created_at": "2013-09-30T13:46:02Z",
   "last_activity_at": "2013-09-30T13:46:02Z",
   "creator_id": 3,
@@ -986,6 +994,7 @@ POST /projects
 | `snippets_access_level` | string | no | One of `disabled`, `private` or `enabled` |
 | `resolve_outdated_diff_discussions` | boolean | no | Automatically resolve merge request diffs discussions on lines changed with a push |
 | `container_registry_enabled` | boolean | no | Enable container registry for this project |
+| `container_expiration_policy_attributes` | hash | no | Update the container expiration policy for this project. Accepts: `cadence` (string), `keep_n` (string), `older_than` (string), `name_regex` (string), `enabled` (boolean) |
 | `shared_runners_enabled` | boolean | no | Enable shared runners for this project |
 | `visibility` | string | no | See [project visibility level](#project-visibility-level) |
 | `import_url` | string | no | URL to import repository from |
@@ -1115,6 +1124,7 @@ PUT /projects/:id
 | `snippets_access_level` | string | no | One of `disabled`, `private` or `enabled` |
 | `resolve_outdated_diff_discussions` | boolean | no | Automatically resolve merge request diffs discussions on lines changed with a push |
 | `container_registry_enabled` | boolean | no | Enable container registry for this project |
+| `container_expiration_policy_attributes` | hash | no | Update the container expiration policy for this project. Accepts: `cadence` (string), `keep_n` (string), `older_than` (string), `name_regex` (string), `enabled` (boolean) |
 | `shared_runners_enabled` | boolean | no | Enable shared runners for this project |
 | `visibility` | string | no | See [project visibility level](#project-visibility-level) |
 | `import_url` | string | no | URL to import repository from |

lib/api/entities.rb

@@ -178,6 +178,15 @@ module API
       expose :only_protected_branches
     end
 
+    class ContainerExpirationPolicy < Grape::Entity
+      expose :cadence
+      expose :enabled
+      expose :keep_n
+      expose :older_than
+      expose :name_regex
+      expose :next_run_at
+    end
+
     class ProjectImportStatus < ProjectIdentity
       expose :import_status
 
@@ -276,6 +285,8 @@ module API
       expose :owner, using: Entities::UserBasic, unless: ->(project, options) { project.group }
       expose :resolve_outdated_diff_discussions
       expose :container_registry_enabled
+      expose :container_expiration_policy, using: Entities::ContainerExpirationPolicy,
+        if: -> (project, _) { project.container_expiration_policy }
 
       # Expose old field names with the new permissions methods to keep API compatible
       # TODO: remove in API v5, replaced by *_access_level
@@ -341,6 +352,7 @@ module API
         # MR describing the solution: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/20555
         super(projects_relation).preload(:group)
                                 .preload(:ci_cd_settings)
+                                .preload(:container_expiration_policy)
                                 .preload(:auto_devops)
                                 .preload(project_group_links: { group: :route },
                                          fork_network: :root_project,

lib/api/helpers/projects_helpers.rb

@@ -32,6 +32,9 @@ module API
         optional :resolve_outdated_diff_discussions, type: Boolean, desc: 'Automatically resolve merge request diffs discussions on lines changed with a push'
         optional :remove_source_branch_after_merge, type: Boolean, desc: 'Remove the source branch by default after merge'
         optional :container_registry_enabled, type: Boolean, desc: 'Flag indication if the container registry is enabled for that project'
+        optional :container_expiration_policy_attributes, type: Hash do
+          use :optional_container_expiration_policy_params
+        end
         optional :lfs_enabled, type: Boolean, desc: 'Flag indication if Git LFS is enabled for that project'
         optional :visibility, type: String, values: Gitlab::VisibilityLevel.string_values, desc: 'The visibility of the project.'
         optional :public_builds, type: Boolean, desc: 'Perform public builds'
@@ -72,6 +75,14 @@ module API
       params :optional_update_params_ee do
       end
 
+      params :optional_container_expiration_policy_params do
+        optional :cadence, type: String, desc: 'Container expiration policy cadence for recurring job'
+        optional :keep_n, type: String, desc: 'Container expiration policy number of images to keep'
+        optional :older_than, type: String, desc: 'Container expiration policy remove images older than value'
+        optional :name_regex, type: String, desc: 'Container expiration policy regex for image removal'
+        optional :enabled, type: Boolean, desc: 'Flag indication if container expiration policy is enabled'
+      end
+
       def self.update_params_at_least_one_of
         [
           :auto_devops_enabled,
@@ -84,6 +95,7 @@ module API
           :ci_config_path,
           :ci_default_git_depth,
           :container_registry_enabled,
+          :container_expiration_policy_attributes,
           :default_branch,
           :description,
           :autoclose_referenced_issues,

spec/requests/api/projects_spec.rb

@@ -2251,6 +2251,22 @@ describe API::Projects do
         put api("/projects/#{project3.id}", user4), params: project_param
         expect(response).to have_gitlab_http_status(403)
       end
+
+      it 'updates container_expiration_policy' do
+        project_param = {
+          container_expiration_policy_attributes: {
+            cadence: '1month',
+            keep_n: 1
+          }
+        }
+
+        put api("/projects/#{project3.id}", user4), params: project_param
+
+        expect(response).to have_gitlab_http_status(200)
+
+        expect(json_response['container_expiration_policy']['cadence']).to eq('1month')
+        expect(json_response['container_expiration_policy']['keep_n']).to eq(1)
+      end
     end
 
     context 'when authenticated as project developer' do