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

This commit is contained in:
andres-portainer
2026-06-05 01:51:18 -03:00
committed by GitHub
parent a779c839b7
commit 8daf0bb2a9
22 changed files with 2580 additions and 64 deletions
@@ -5,11 +5,13 @@ import (
"net/http/httptest"
"testing"
"github.com/gorilla/mux"
portainer "github.com/portainer/portainer/api"
"github.com/portainer/portainer/api/dataservices"
gittypes "github.com/portainer/portainer/api/git/types"
"github.com/portainer/portainer/api/http/security"
httperror "github.com/portainer/portainer/pkg/libhttp/error"
"github.com/gorilla/mux"
"github.com/segmentio/encoding/json"
"github.com/stretchr/testify/require"
)
@@ -33,7 +35,8 @@ func TestCustomTemplateFile(t *testing.T) {
require.NoError(t, err)
require.NoError(t, tx.CustomTemplate().Create(&portainer.CustomTemplate{ID: 2, EntryPoint: templateEntrypoint, ProjectPath: path}))
require.NoError(t, tx.ResourceControl().Create(&portainer.ResourceControl{ID: 1, ResourceID: "2", Type: portainer.CustomTemplateResourceControl,
require.NoError(t, tx.ResourceControl().Create(&portainer.ResourceControl{
ID: 1, ResourceID: "2", Type: portainer.CustomTemplateResourceControl,
UserAccesses: []portainer.UserResourceAccess{{UserID: 2}},
TeamAccesses: []portainer.TeamResourceAccess{{TeamID: 1}},
}))
@@ -59,6 +62,7 @@ func TestCustomTemplateFile(t *testing.T) {
rr, r := test("1", &security.RestrictedRequestContext{UserID: 1, IsAdmin: true})
require.Nil(t, r)
require.Equal(t, http.StatusOK, rr.Result().StatusCode)
var res struct{ FileContent string }
require.NoError(t, json.NewDecoder(rr.Body).Decode(&res))
require.Equal(t, templateContent, res.FileContent)
@@ -74,6 +78,7 @@ func TestCustomTemplateFile(t *testing.T) {
rr, r := test("2", &security.RestrictedRequestContext{UserID: 2})
require.Nil(t, r)
require.Equal(t, http.StatusOK, rr.Result().StatusCode)
var res struct{ FileContent string }
require.NoError(t, json.NewDecoder(rr.Body).Decode(&res))
require.Equal(t, templateContent, res.FileContent)
@@ -83,6 +88,7 @@ func TestCustomTemplateFile(t *testing.T) {
rr, r := test("2", &security.RestrictedRequestContext{UserID: 3, UserMemberships: []portainer.TeamMembership{{ID: 1, UserID: 3, TeamID: 1}}})
require.Nil(t, r)
require.Equal(t, http.StatusOK, rr.Result().StatusCode)
var res struct{ FileContent string }
require.NoError(t, json.NewDecoder(rr.Body).Decode(&res))
require.Equal(t, templateContent, res.FileContent)
@@ -94,3 +100,47 @@ func TestCustomTemplateFile(t *testing.T) {
require.Equal(t, http.StatusForbidden, r.StatusCode)
})
}
func TestCustomTemplateFile_GitTemplate(t *testing.T) {
t.Parallel()
handler, ds, fs := newTestHandler(t)
templateContent := "git template content"
configFilePath := "docker-compose.yml"
require.NoError(t, ds.UpdateTx(func(tx dataservices.DataStoreTx) error {
src := &portainer.Source{
Type: portainer.SourceTypeGit,
GitConfig: &gittypes.RepoConfig{URL: "https://github.com/example/repo"},
}
err := tx.Source().Create(src)
require.NoError(t, err)
path, err := fs.StoreCustomTemplateFileFromBytes("10", configFilePath, []byte(templateContent))
require.NoError(t, err)
return tx.CustomTemplate().Create(&portainer.CustomTemplate{
ID: 10,
EntryPoint: "should-not-be-used.yml",
ProjectPath: path,
ArtifactSources: &portainer.ArtifactSources{
Artifact: portainer.Artifact{ConfigFilePath: configFilePath},
SourceIDs: []portainer.SourceID{src.ID},
},
})
}))
r := httptest.NewRequest(http.MethodGet, "/custom_templates/10/file", nil)
r = mux.SetURLVars(r, map[string]string{"id": "10"})
ctx := security.StoreRestrictedRequestContext(r, &security.RestrictedRequestContext{UserID: 1, IsAdmin: true})
r = r.WithContext(ctx)
rr := httptest.NewRecorder()
herr := handler.customTemplateFile(rr, r)
require.Nil(t, herr)
require.Equal(t, http.StatusOK, rr.Result().StatusCode)
var res struct{ FileContent string }
require.NoError(t, json.NewDecoder(rr.Body).Decode(&res))
require.Equal(t, templateContent, res.FileContent)
}