c60755fbc7
Co-authored-by: Hannah Cooper <hannah.cooper@portainer.io> Co-authored-by: Chaim Lev-Ari <chiptus@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Ali <83188384+testA113@users.noreply.github.com> Co-authored-by: Steven Kang <skan070@gmail.com> Co-authored-by: Josiah Clumont <josiah.clumont@portainer.io> Co-authored-by: nickl-portainer <nicholas.loomans@portainer.io> Co-authored-by: andres-portainer <91705312+andres-portainer@users.noreply.github.com> Co-authored-by: Oscar Zhou <100548325+oscarzhou-portainer@users.noreply.github.com> Co-authored-by: ferreiraborgesaxel-design <ferreiraborgesaxel-design@users.noreply.github.com>
90 lines
3.1 KiB
Go
90 lines
3.1 KiB
Go
package sources
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"io"
|
|
"net/http"
|
|
|
|
portainer "github.com/portainer/portainer/api"
|
|
"github.com/portainer/portainer/api/dataservices"
|
|
gittypes "github.com/portainer/portainer/api/git/types"
|
|
httperror "github.com/portainer/portainer/pkg/libhttp/error"
|
|
"github.com/portainer/portainer/pkg/libhttp/request"
|
|
"github.com/portainer/portainer/pkg/libhttp/response"
|
|
)
|
|
|
|
// @id GitOpsSourcesTestGit
|
|
// @summary Test a Git source connection
|
|
// @description Tests connectivity for a GitOps source, applying optional overrides to the stored configuration.
|
|
// @description **Access policy**: admin
|
|
// @tags gitops
|
|
// @security ApiKeyAuth
|
|
// @security jwt
|
|
// @accept json
|
|
// @produce json
|
|
// @param id path int true "Source identifier"
|
|
// @param body body GitSourceUpdatePayload false "Optional connection overrides; omitted fields fall back to stored values"
|
|
// @success 200 {object} ConnectionTestResult "Connection test result"
|
|
// @failure 400 "Invalid request payload"
|
|
// @failure 403 "Access denied"
|
|
// @failure 404 "Source not found"
|
|
// @failure 500 "Server error"
|
|
// @router /gitops/sources/{id}/test [post]
|
|
func (h *Handler) sourceTestConnection(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
|
sourceID, err := request.RetrieveNumericRouteVariableValue(r, "id")
|
|
if err != nil {
|
|
return httperror.BadRequest("Invalid source identifier route variable", err)
|
|
}
|
|
|
|
var payload GitSourceUpdatePayload
|
|
if err := request.DecodeAndValidateJSONPayload(r, &payload); err != nil && !errors.Is(err, io.EOF) {
|
|
return httperror.BadRequest("Invalid request payload", err)
|
|
}
|
|
|
|
var src *portainer.Source
|
|
if err := h.dataStore.ViewTx(func(tx dataservices.DataStoreTx) error {
|
|
src, err = tx.Source().Read(portainer.SourceID(sourceID))
|
|
return err
|
|
}); h.dataStore.IsErrObjectNotFound(err) {
|
|
return httperror.NotFound("Unable to find a source with the specified identifier", err)
|
|
} else if err != nil {
|
|
return httperror.InternalServerError("Unable to find source", err)
|
|
}
|
|
|
|
if err := ApplyGitSourceChanges(src, payload); errors.Is(err, ErrNotGitSource) {
|
|
return httperror.BadRequest("Source is not a Git source", err)
|
|
} else if err != nil {
|
|
return httperror.InternalServerError("Unable to apply source changes", err)
|
|
}
|
|
|
|
if src.Git == nil {
|
|
return httperror.InternalServerError("Source has no git configuration", nil)
|
|
}
|
|
|
|
result := testSourceConnection(r.Context(), h.gitService, src.Git)
|
|
|
|
return response.JSON(w, result)
|
|
}
|
|
|
|
type ConnectionTestResult struct {
|
|
Success bool `json:"success"`
|
|
Error string `json:"error,omitempty"`
|
|
}
|
|
|
|
// testSourceConnection verifies that a git repository is reachable with the given config.
|
|
func testSourceConnection(ctx context.Context, gitService portainer.GitService, config *gittypes.RepoConfig) ConnectionTestResult {
|
|
var username, password string
|
|
if config.Authentication != nil {
|
|
username = config.Authentication.Username
|
|
password = config.Authentication.Password
|
|
}
|
|
|
|
_, err := gitService.ListRefs(ctx, config.URL, username, password, false, config.TLSSkipVerify)
|
|
if err != nil {
|
|
return ConnectionTestResult{Success: false, Error: err.Error()}
|
|
}
|
|
|
|
return ConnectionTestResult{Success: true}
|
|
}
|