feat(customtemplates): use Sources for CustomTemplates BE-12919 (#2759)

api/http/handler/gitops/sources/delete.go

@@ -13,11 +13,11 @@ import (
 	"github.com/portainer/portainer/pkg/libhttp/response"
 )
 
-var ErrSourceInUse = errors.New("source is used by one or more workflows")
+var ErrSourceInUse = errors.New("source is used by one or more workflows or custom templates")
 
 // @id GitOpsSourcesDelete
 // @summary Delete a source
-// @description Deletes an existing GitOps source. Returns 409 if the source is referenced by any workflow.
+// @description Deletes an existing GitOps source. Returns 409 if the source is referenced by any workflow or custom template.
 // @description **Access policy**: admin
 // @tags gitops
 // @security ApiKeyAuth
@@ -27,7 +27,7 @@ var ErrSourceInUse = errors.New("source is used by one or more workflows")
 // @failure 400 "Invalid request"
 // @failure 403 "Access denied"
 // @failure 404 "Source not found"
-// @failure 409 "Source is in use by one or more workflows"
+// @failure 409 "Source is in use by one or more workflows or custom templates"
 // @failure 500 "Server error"
 // @router /gitops/sources/{id} [delete]
 func (h *Handler) sourceDelete(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
@@ -56,11 +56,22 @@ func (h *Handler) sourceDelete(w http.ResponseWriter, r *http.Request) *httperro
 			}
 		}
 
+		templates, err := tx.CustomTemplate().ReadAll(func(t portainer.CustomTemplate) bool {
+			return t.ArtifactSources != nil && slices.Contains(t.ArtifactSources.SourceIDs, portainer.SourceID(sourceID))
+		})
+		if err != nil {
+			return err
+		}
+
+		if len(templates) > 0 {
+			return ErrSourceInUse
+		}
+
 		return tx.Source().Delete(portainer.SourceID(sourceID))
 	}); h.dataStore.IsErrObjectNotFound(err) {
 		return httperror.NotFound("Unable to find a source with the specified identifier", err)
 	} else if errors.Is(err, ErrSourceInUse) {
-		return httperror.Conflict("Source is used by one or more workflows", err)
+		return httperror.Conflict("Source is used by one or more workflows or custom templates", err)
 	} else if err != nil {
 		return httperror.InternalServerError("Unable to delete source", err)
 	}

api/http/handler/gitops/sources/delete_test.go

@@ -14,6 +14,7 @@ import (
 
 func TestSourceDelete_Success(t *testing.T) {
 	t.Parallel()
+
 	_, store := datastore.MustNewTestStore(t, false, true)
 
 	var srcID portainer.SourceID
@@ -35,6 +36,7 @@ func TestSourceDelete_Success(t *testing.T) {
 
 func TestSourceDelete_NotFound(t *testing.T) {
 	t.Parallel()
+
 	_, store := datastore.MustNewTestStore(t, false, true)
 
 	require.NoError(t, store.UpdateTx(func(tx dataservices.DataStoreTx) error {
@@ -50,6 +52,7 @@ func TestSourceDelete_NotFound(t *testing.T) {
 
 func TestSourceDelete_InUse(t *testing.T) {
 	t.Parallel()
+
 	_, store := datastore.MustNewTestStore(t, false, true)
 
 	var srcID portainer.SourceID
@@ -75,6 +78,7 @@ func TestSourceDelete_InUse(t *testing.T) {
 
 func TestSourceDelete_NonNumericID(t *testing.T) {
 	t.Parallel()
+
 	_, store := datastore.MustNewTestStore(t, false, true)
 
 	require.NoError(t, store.UpdateTx(func(tx dataservices.DataStoreTx) error {
@@ -87,3 +91,34 @@ func TestSourceDelete_NonNumericID(t *testing.T) {
 
 	require.Equal(t, http.StatusBadRequest, rr.Code)
 }
+
+func TestSourceDelete_InUseByCustomTemplate(t *testing.T) {
+	t.Parallel()
+
+	_, store := datastore.MustNewTestStore(t, false, true)
+
+	var srcID portainer.SourceID
+	require.NoError(t, store.UpdateTx(func(tx dataservices.DataStoreTx) error {
+		src := &portainer.Source{Name: "in-use-by-template", Type: portainer.SourceTypeGit}
+		err := tx.Source().Create(src)
+		require.NoError(t, err)
+		srcID = src.ID
+
+		ct := &portainer.CustomTemplate{
+			ID: 1,
+			ArtifactSources: &portainer.ArtifactSources{
+				SourceIDs: []portainer.SourceID{src.ID},
+			},
+		}
+		err = tx.CustomTemplate().Create(ct)
+		require.NoError(t, err)
+
+		return tx.User().Create(&portainer.User{ID: 1, Role: portainer.AdministratorRole})
+	}))
+
+	h := newTestHandler(t, store)
+	rr := httptest.NewRecorder()
+	h.ServeHTTP(rr, buildDeleteReq(t, 1, int(srcID)))
+
+	require.Equal(t, http.StatusConflict, rr.Code)
+}