Ensure container_expiration_policy keep_n is an integer

changelogs/unreleased/keep_n_int.yml

+---
+title: Ensure container_expiration_policy keep_n is an integer
+merge_request: 49805
+author: Mathieu Parent
+type: changed

doc/api/projects.md

@@ -1057,7 +1057,7 @@ POST /projects
 | `build_timeout`                                             | integer | **{dotted-circle}** No | The maximum amount of time in minutes that a job is able run (in seconds). |
 | `builds_access_level`                                       | string  | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
 | `ci_config_path`                                            | string  | **{dotted-circle}** No | The path to CI configuration file. |
-| `container_expiration_policy_attributes`                    | hash    | **{dotted-circle}** No | Update the image cleanup policy for this project. Accepts: `cadence` (string), `keep_n` (string), `older_than` (string), `name_regex` (string), `name_regex_delete` (string), `name_regex_keep` (string), `enabled` (boolean). |
+| `container_expiration_policy_attributes`                    | hash    | **{dotted-circle}** No | Update the image cleanup policy for this project. Accepts: `cadence` (string), `keep_n` (integer), `older_than` (string), `name_regex` (string), `name_regex_delete` (string), `name_regex_keep` (string), `enabled` (boolean). |
 | `container_registry_enabled`                                | boolean | **{dotted-circle}** No | Enable container registry for this project. |
 | `default_branch`                                            | string  | **{dotted-circle}** No | `master` by default. |
 | `description`                                               | string  | **{dotted-circle}** No | Short project description. |
@@ -1206,7 +1206,7 @@ PUT /projects/:id
 | `ci_config_path`                                            | string         | **{dotted-circle}** No | The path to CI configuration file. |
 | `ci_default_git_depth`                                      | integer        | **{dotted-circle}** No | Default number of revisions for [shallow cloning](../ci/pipelines/settings.md#git-shallow-clone). |
 | `ci_forward_deployment_enabled`                             | boolean        | **{dotted-circle}** No | When a new deployment job starts, [skip older deployment jobs](../ci/pipelines/settings.md#skip-outdated-deployment-jobs) that are still pending |
-| `container_expiration_policy_attributes`                    | hash           | **{dotted-circle}** No | Update the image cleanup policy for this project. Accepts: `cadence` (string), `keep_n` (string), `older_than` (string), `name_regex` (string), `name_regex_delete` (string), `name_regex_keep` (string), `enabled` (boolean). |
+| `container_expiration_policy_attributes`                    | hash           | **{dotted-circle}** No | Update the image cleanup policy for this project. Accepts: `cadence` (string), `keep_n` (integer), `older_than` (string), `name_regex` (string), `name_regex_delete` (string), `name_regex_keep` (string), `enabled` (boolean). |
 | `container_registry_enabled`                                | boolean        | **{dotted-circle}** No | Enable container registry for this project. |
 | `default_branch`                                            | string         | **{dotted-circle}** No | `master` by default. |
 | `description`                                               | string         | **{dotted-circle}** No | Short project description. |

lib/api/helpers/projects_helpers.rb

@@ -99,7 +99,7 @@ module API
 
       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 :keep_n, type: Integer, 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 :name_regex_keep, type: String, desc: 'Container expiration policy regex for image retention'

spec/requests/api/projects_spec.rb

@@ -2711,6 +2711,22 @@ RSpec.describe API::Projects do
         expect(response).to have_gitlab_http_status(:bad_request)
         expect(json_response['message']['container_expiration_policy.name_regex_keep']).to contain_exactly('not valid RE2 syntax: missing ]: [')
       end
+
+      it "doesn't update container_expiration_policy with invalid keep_n" do
+        project_param = {
+          container_expiration_policy_attributes: {
+            cadence: '1month',
+            enabled: true,
+            keep_n: 'not_int',
+            name_regex_keep: 'foo.*'
+          }
+        }
+
+        put api("/projects/#{project3.id}", user4), params: project_param
+
+        expect(response).to have_gitlab_http_status(:bad_request)
+        expect(json_response['error']).to eq('container_expiration_policy_attributes[keep_n] is invalid')
+      end
     end
 
     context 'when authenticated as project developer' do