Merge pull request #981 from lfu/pxe_customization_template_907

Add endpoint for creating/updating/deleting PXE Customization Templates

Author: abellotti

config/api.yml

@@ -1346,17 +1346,40 @@
     :identifier: customization_template_accord
     :options:
     - :collection
-    :verbs: *g
+    :verbs: *gpppd
     :klass: CustomizationTemplate
     :collection_actions:
       :get:
       - :name: read
         :identifier: customization_template_view
-    :subcollection_actions:
+      :post:
+      - :name: query
+        :identifier: customization_template_view
+      - :name: create
+        :identifier: customization_template_new
+      - :name: edit
+        :identifier: customization_template_edit
+      - :name: delete
+        :identifier: customization_template_delete
+    :resource_actions:
       :get:
       - :name: read
         :identifier: customization_template_view
-    :resource_actions:
+      :post:
+      - :name: edit
+        :identifier: customization_template_edit
+      - :name: delete
+        :identifier: customization_template_delete
+      :patch:
+      - :name: edit
+        :identifier: customization_template_edit
+      :put:
+      - :name: edit
+        :identifier: customization_template_edit
+      :delete:
+      - :name: delete
+        :identifier: customization_template_delete
+    :subcollection_actions:
       :get:
       - :name: read
         :identifier: customization_template_view

spec/requests/collections_spec.rb

@@ -378,6 +378,11 @@ def test_collection_bulk_query(collection, collection_url, klass, id = nil)
       test_collection_query(:customization_scripts, api_customization_scripts_url, CustomizationScript)
     end
 
+    it 'query CustomizationTemplates' do
+      FactoryBot.create(:customization_template)
+      test_collection_query(:customization_templates, api_customization_templates_url, CustomizationTemplate)
+    end
+
     it 'query GuestDevices' do
       FactoryBot.create(:guest_device)
       test_collection_query(:guest_devices, api_guest_devices_url, GuestDevice)
@@ -715,6 +720,11 @@ def test_collection_bulk_query(collection, collection_url, klass, id = nil)
       test_collection_bulk_query(:customization_scripts, api_customization_scripts_url, CustomizationScript)
     end
 
+    it 'bulk query CustomizationTemplates' do
+      FactoryBot.create(:customization_template)
+      test_collection_bulk_query(:customization_templates, api_customization_templates_url, CustomizationTemplate)
+    end
+
     it 'bulk query GuestDevices' do
       FactoryBot.create(:guest_device)
       test_collection_bulk_query(:guest_devices, api_guest_devices_url, GuestDevice)

spec/requests/customization_templates_spec.rb

@@ -42,4 +42,138 @@
       expect(response).to have_http_status(:forbidden)
     end
   end
+
+  describe 'POST /api/customization_templates' do
+    it 'forbids creating a customization template without an appropriate role' do
+      api_basic_authorize
+      post(api_customization_templates_url, :params => {:action => 'create'})
+      expect(response).to have_http_status(:forbidden)
+    end
+
+    it 'forbids updating a customization template without an appropriate role' do
+      api_basic_authorize
+      post(api_customization_templates_url, :params => {:action => 'edit'})
+      expect(response).to have_http_status(:forbidden)
+    end
+
+    it 'forbids deleting a customization template without an appropriate role' do
+      api_basic_authorize
+      post(api_customization_templates_url, :params => {:action => 'delete'})
+      expect(response).to have_http_status(:forbidden)
+    end
+
+    it 'creates a customization template with an appropriate role' do
+      pxe_image_type = FactoryBot.create(:pxe_image_type)
+      params = {
+        "name"              => 'name',
+        "description"       => 'description',
+        "script"            => 'test',
+        "type"              => 'CustomizationTemplateKickstart',
+        "pxe_image_type_id" => pxe_image_type.id.to_s
+      }
+      api_basic_authorize collection_action_identifier(:customization_templates, :create)
+
+      post(api_customization_templates_url, :params => params)
+
+      expect(response).to have_http_status(:ok)
+      expect(response.parsed_body["results"].first).to include(params)
+    end
+
+    it 'updates a customization template with an appropriate role' do
+      api_basic_authorize collection_action_identifier(:customization_templates, :edit)
+
+      post(api_customization_templates_url, :params => gen_request(:edit, 'id' => template.id, 'description' => 'description updated'))
+
+      expect(response).to have_http_status(:ok)
+      expect(response.parsed_body["results"].first).to include('href' => api_customization_template_url(nil, template))
+      expect(template.reload.description).to eq('description updated')
+    end
+
+    it 'deletes a customization template with an appropriate role' do
+      api_basic_authorize collection_action_identifier(:customization_templates, :delete)
+
+      post(api_customization_templates_url, :params => gen_request(:delete, 'id' => template.id, 'href' => api_customization_template_url(nil, template)))
+
+      expect(response).to have_http_status(:ok)
+      expect(CustomizationTemplate.exists?(template.id)).to be false
+    end
+  end
+
+  describe 'POST /api/customization_templates/:id' do
+    it 'forbids updating a customization template without an appropriate role' do
+      api_basic_authorize
+      post(api_customization_template_url(nil, template), :params => {:action => 'edit', :description => 'description updated'})
+      expect(response).to have_http_status(:forbidden)
+    end
+
+    it 'forbids deleting a customization template without an appropriate role' do
+      api_basic_authorize
+      post(api_customization_template_url(nil, template), :params => {:action => 'delete'})
+      expect(response).to have_http_status(:forbidden)
+    end
+
+    it 'updates a customization template with an appropriate role' do
+      api_basic_authorize collection_action_identifier(:customization_templates, :edit)
+
+      post(api_customization_template_url(nil, template), :params => {:action => 'edit', :description => 'description updated'})
+
+      expect(template.reload.description).to eq('description updated')
+      expect(response).to have_http_status(:ok)
+      expect(response.parsed_body).to include('href' => api_customization_template_url(nil, template))
+    end
+
+    it 'deletes a customization template with an appropriate role' do
+      api_basic_authorize collection_action_identifier(:customization_templates, :delete)
+
+      expect do
+        post(api_customization_template_url(nil, template), :params => {:action => 'delete'})
+      end.to change(CustomizationTemplate, :count).by(-1)
+
+      expect(response).to have_http_status(:ok)
+    end
+  end
+
+  describe 'PUT /api/customization_templates/:id' do
+    it 'updates a customization template with an appropriate role' do
+      api_basic_authorize(action_identifier(:customization_templates, :edit))
+      put(api_customization_template_url(nil, template), :params => {:description => 'description updated'})
+      expect(response).to have_http_status(:ok)
+      expect(template.reload.description).to eq('description updated')
+    end
+
+    it 'forbids updating a customization template without an appropriate role' do
+      api_basic_authorize
+      put(api_customization_template_url(nil, template), :params => {:description => 'description updated'})
+      expect(response).to have_http_status(:forbidden)
+    end
+  end
+
+  describe 'PATCH /api/customization_templates/:id' do
+    it 'updates a customization template with an appropriate role' do
+      api_basic_authorize(action_identifier(:customization_templates, :edit))
+      patch(api_customization_template_url(nil, template), :params => {:description => 'description updated'})
+      expect(response).to have_http_status(:ok)
+      expect(template.reload.description).to eq('description updated')
+    end
+
+    it 'forbids updating a customization template without an appropriate role' do
+      api_basic_authorize
+      patch(api_customization_template_url(nil, template), :params => {:description => 'description updated'})
+      expect(response).to have_http_status(:forbidden)
+    end
+  end
+
+  describe 'DELETE /api/customization_templates/:id' do
+    it "deletes a customization template with an appropriate role" do
+      api_basic_authorize(action_identifier(:customization_templates, :delete))
+      delete(api_customization_template_url(nil, template))
+      expect(response).to have_http_status(:no_content)
+    end
+
+    it 'forbids deleting a customization template without an appropriate role' do
+      api_basic_authorize
+      delete(api_customization_template_url(nil, template))
+      expect(response).to have_http_status(:forbidden)
+    end
+  end
 end