particle-os/debian-forge-composer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

worker/server: rename JobStatus() to JobInfo()

Browse source 
Since the `jobStatus` functions return a `JobInfo`
struct that contains the `JobStatus`, it makes sense
to rename the function names for the sake of consistency.
This commit is contained in:
Gianluca Zuccarelli 2022-07-26 12:48:47 +01:00 • committed by Tomáš Hozza
parent 95c8657f9e
commit e5d9d2d045
7 changed files with 51 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

26
internal/cloudapi/v2/handler.go
View file

@ -576,7 +576,7 @@ func (h *apiHandlers) getComposeStatusImpl(ctx echo.Context, id string) error {
if jobType == worker.JobTypeOSBuild {
var result worker.OSBuildJobResult
jobInfo, err := h.server.workers.OSBuildJobStatus(jobId, &result)
jobInfo, err := h.server.workers.OSBuildJobInfo(jobId, &result)
if err != nil {
return HTTPError(ErrorMalformedOSBuildJobResult)
}
@ -616,7 +616,7 @@ func (h *apiHandlers) getComposeStatusImpl(ctx echo.Context, id string) error {
})
} else if jobType == worker.JobTypeKojiFinalize {
var result worker.KojiFinalizeJobResult
finalizeInfo, err := h.server.workers.KojiFinalizeJobStatus(jobId, &result)
finalizeInfo, err := h.server.workers.KojiFinalizeJobInfo(jobId, &result)
if err != nil {
return HTTPError(ErrorMalformedOSBuildJobResult)
}
@ -624,7 +624,7 @@ func (h *apiHandlers) getComposeStatusImpl(ctx echo.Context, id string) error {
return HTTPError(ErrorUnexpectedNumberOfImageBuilds)
}
var initResult worker.KojiInitJobResult
_, err = h.server.workers.KojiInitJobStatus(finalizeInfo.Deps[0], &initResult)
_, err = h.server.workers.KojiInitJobInfo(finalizeInfo.Deps[0], &initResult)
if err != nil {
return HTTPError(ErrorMalformedOSBuildJobResult)
}
@ -632,7 +632,7 @@ func (h *apiHandlers) getComposeStatusImpl(ctx echo.Context, id string) error {
var buildJobStatuses []ImageStatus
for i := 1; i < len(finalizeInfo.Deps); i++ {
var buildJobResult worker.OSBuildJobResult
buildInfo, err := h.server.workers.OSBuildJobStatus(finalizeInfo.Deps[i], &buildJobResult)
buildInfo, err := h.server.workers.OSBuildJobInfo(finalizeInfo.Deps[i], &buildJobResult)
if err != nil {
return HTTPError(ErrorMalformedOSBuildJobResult)
}
@ -816,7 +816,7 @@ func (h *apiHandlers) getComposeMetadataImpl(ctx echo.Context, id string) error
}
var result worker.OSBuildJobResult
buildInfo, err := h.server.workers.OSBuildJobStatus(jobId, &result)
buildInfo, err := h.server.workers.OSBuildJobInfo(jobId, &result)
if err != nil {
return HTTPErrorWithInternal(ErrorComposeNotFound, err)
}
@ -939,13 +939,13 @@ func (h *apiHandlers) getComposeLogsImpl(ctx echo.Context, id string) error {
switch jobType {
case worker.JobTypeKojiFinalize:
var finalizeResult worker.KojiFinalizeJobResult
finalizeInfo, err := h.server.workers.KojiFinalizeJobStatus(jobId, &finalizeResult)
finalizeInfo, err := h.server.workers.KojiFinalizeJobInfo(jobId, &finalizeResult)
if err != nil {
return HTTPErrorWithInternal(ErrorComposeNotFound, err)
}
var initResult worker.KojiInitJobResult
_, err = h.server.workers.KojiInitJobStatus(finalizeInfo.Deps[0], &initResult)
_, err = h.server.workers.KojiInitJobInfo(finalizeInfo.Deps[0], &initResult)
if err != nil {
return HTTPErrorWithInternal(ErrorComposeNotFound, err)
}
@ -959,7 +959,7 @@ func (h *apiHandlers) getComposeLogsImpl(ctx echo.Context, id string) error {
switch buildJobType {
case worker.JobTypeOSBuild:
var buildResult worker.OSBuildJobResult
_, err = h.server.workers.OSBuildJobStatus(finalizeInfo.Deps[i], &buildResult)
_, err = h.server.workers.OSBuildJobInfo(finalizeInfo.Deps[i], &buildResult)
if err != nil {
return HTTPErrorWithInternal(ErrorComposeNotFound, err)
}
@ -978,7 +978,7 @@ func (h *apiHandlers) getComposeLogsImpl(ctx echo.Context, id string) error {
case worker.JobTypeOSBuild:
var buildResult worker.OSBuildJobResult
_, err = h.server.workers.OSBuildJobStatus(jobId, &buildResult)
_, err = h.server.workers.OSBuildJobInfo(jobId, &buildResult)
if err != nil {
return HTTPErrorWithInternal(ErrorComposeNotFound, err)
}
@ -1004,7 +1004,7 @@ func manifestJobResultsFromJobDeps(w *worker.Server, deps []uuid.UUID) (*worker.
return nil, err
}
if depType == worker.JobTypeManifestIDOnly {
_, err = w.ManifestJobStatus(deps[i], &manifestResult)
_, err = w.ManifestJobInfo(deps[i], &manifestResult)
if err != nil {
return nil, err
}
@ -1036,7 +1036,7 @@ func (h *apiHandlers) getComposeManifestsImpl(ctx echo.Context, id string) error
switch jobType {
case worker.JobTypeKojiFinalize:
var finalizeResult worker.KojiFinalizeJobResult
finalizeInfo, err := h.server.workers.KojiFinalizeJobStatus(jobId, &finalizeResult)
finalizeInfo, err := h.server.workers.KojiFinalizeJobInfo(jobId, &finalizeResult)
if err != nil {
return HTTPErrorWithInternal(ErrorComposeNotFound, err)
}
@ -1060,7 +1060,7 @@ func (h *apiHandlers) getComposeManifestsImpl(ctx echo.Context, id string) error
if len(buildJob.Manifest) != 0 {
manifest = buildJob.Manifest
} else {
buildInfo, err := h.server.workers.OSBuildJobStatus(finalizeInfo.Deps[i], &worker.OSBuildJobResult{})
buildInfo, err := h.server.workers.OSBuildJobInfo(finalizeInfo.Deps[i], &worker.OSBuildJobResult{})
if err != nil {
return HTTPErrorWithInternal(ErrorComposeNotFound, err)
}
@ -1089,7 +1089,7 @@ func (h *apiHandlers) getComposeManifestsImpl(ctx echo.Context, id string) error
if len(buildJob.Manifest) != 0 {
manifest = buildJob.Manifest
} else {
buildInfo, err := h.server.workers.OSBuildJobStatus(jobId, &worker.OSBuildJobResult{})
buildInfo, err := h.server.workers.OSBuildJobInfo(jobId, &worker.OSBuildJobResult{})
if err != nil {
return HTTPErrorWithInternal(ErrorComposeNotFound, err)
}

2
internal/cloudapi/v2/server.go
View file

@ -292,7 +292,7 @@ func generateManifest(ctx context.Context, workers *worker.Server, depsolveJobID
return
}
_, err = workers.DepsolveJobStatus(depsolveJobID, &depsolveResults)
_, err = workers.DepsolveJobInfo(depsolveJobID, &depsolveResults)
if err != nil {
reason := "Error reading depsolve status"
jobResult.JobError = clienterrors.WorkerClientError(clienterrors.ErrorReadingJobStatus, reason)

2
internal/cloudapi/v2/v2_koji_test.go
View file

@ -458,7 +458,7 @@ func TestKojiCompose(t *testing.T) {
// Finishing of the goroutine handling the manifest job is not deterministic and as a result, we may get
// the second osbuild job first.
// The build jobs ID is determined from the dependencies of the koji-finalize job dependencies.
finalizeInfo, err := workerServer.KojiFinalizeJobStatus(composeId, &worker.KojiFinalizeJobResult{})
finalizeInfo, err := workerServer.KojiFinalizeJobInfo(composeId, &worker.KojiFinalizeJobResult{})
require.NoError(t, err)
buildJobIDs := finalizeInfo.Deps[1:]
require.Len(t, buildJobIDs, 2)

4
internal/weldr/api.go
View file

@ -359,7 +359,7 @@ func (api *API) getComposeStatus(compose store.Compose) *composeStatus {
// All jobs are "osbuild" jobs.
var result worker.OSBuildJobResult
jobInfo, err := api.workers.OSBuildJobStatus(jobId, &result)
jobInfo, err := api.workers.OSBuildJobInfo(jobId, &result)
if err != nil {
panic(err)
}
@ -2196,7 +2196,7 @@ func (api *API) resolveContainersForImageType(bp blueprint.Blueprint, imageType
var result worker.ContainerResolveJobResult
for {
jobInfo, err := api.workers.ContainerResolveJobStatus(jobId, &result)
jobInfo, err := api.workers.ContainerResolveJobInfo(jobId, &result)
if err != nil {
return specs, err

4
internal/weldr/compose_test.go
View file

@ -57,7 +57,7 @@ func TestComposeStatusFromLegacyError(t *testing.T) {
err = api.workers.FinishJob(token, rawResult)
require.NoError(t, err)
jobInfo, err := api.workers.OSBuildJobStatus(jobId, &jobResult)
jobInfo, err := api.workers.OSBuildJobInfo(jobId, &jobResult)
require.NoError(t, err)
state := composeStateFromJobStatus(jobInfo.JobStatus, &jobResult)
@ -100,7 +100,7 @@ func TestComposeStatusFromJobError(t *testing.T) {
err = api.workers.FinishJob(token, rawResult)
require.NoError(t, err)
jobInfo, err := api.workers.OSBuildJobStatus(jobId, &jobResult)
jobInfo, err := api.workers.OSBuildJobInfo(jobId, &jobResult)
require.NoError(t, err)
state := composeStateFromJobStatus(jobInfo.JobStatus, &jobResult)

58
internal/worker/server.go
View file

@ -172,7 +172,7 @@ func (s *Server) JobDependencyChainErrors(id uuid.UUID) (*clienterrors.Error, er
switch jobType {
case JobTypeOSBuild:
var osbuildJR OSBuildJobResult
jobInfo, err = s.OSBuildJobStatus(id, &osbuildJR)
jobInfo, err = s.OSBuildJobInfo(id, &osbuildJR)
if err != nil {
return nil, err
}
@ -180,7 +180,7 @@ func (s *Server) JobDependencyChainErrors(id uuid.UUID) (*clienterrors.Error, er
case JobTypeDepsolve:
var depsolveJR DepsolveJobResult
jobInfo, err = s.DepsolveJobStatus(id, &depsolveJR)
jobInfo, err = s.DepsolveJobInfo(id, &depsolveJR)
if err != nil {
return nil, err
}
@ -188,7 +188,7 @@ func (s *Server) JobDependencyChainErrors(id uuid.UUID) (*clienterrors.Error, er
case JobTypeManifestIDOnly:
var manifestJR ManifestJobByIDResult
jobInfo, err = s.ManifestJobStatus(id, &manifestJR)
jobInfo, err = s.ManifestJobInfo(id, &manifestJR)
if err != nil {
return nil, err
}
@ -196,7 +196,7 @@ func (s *Server) JobDependencyChainErrors(id uuid.UUID) (*clienterrors.Error, er
case JobTypeKojiInit:
var kojiInitJR KojiInitJobResult
jobInfo, err = s.KojiInitJobStatus(id, &kojiInitJR)
jobInfo, err = s.KojiInitJobInfo(id, &kojiInitJR)
if err != nil {
return nil, err
}
@ -204,7 +204,7 @@ func (s *Server) JobDependencyChainErrors(id uuid.UUID) (*clienterrors.Error, er
case JobTypeKojiFinalize:
var kojiFinalizeJR KojiFinalizeJobResult
jobInfo, err = s.KojiFinalizeJobStatus(id, &kojiFinalizeJR)
jobInfo, err = s.KojiFinalizeJobInfo(id, &kojiFinalizeJR)
if err != nil {
return nil, err
}
@ -212,7 +212,7 @@ func (s *Server) JobDependencyChainErrors(id uuid.UUID) (*clienterrors.Error, er
case JobTypeContainerResolve:
var containerResolveJR ContainerResolveJobResult
jobInfo, err = s.ContainerResolveJobStatus(id, &containerResolveJR)
jobInfo, err = s.ContainerResolveJobInfo(id, &containerResolveJR)
if err != nil {
return nil, err
}
@ -247,8 +247,8 @@ func (s *Server) JobDependencyChainErrors(id uuid.UUID) (*clienterrors.Error, er
return nil, nil
}
func (s *Server) OSBuildJobStatus(id uuid.UUID, result *OSBuildJobResult) (*JobInfo, error) {
jobInfo, err := s.jobStatus(id, result)
func (s *Server) OSBuildJobInfo(id uuid.UUID, result *OSBuildJobResult) (*JobInfo, error) {
jobInfo, err := s.jobInfo(id, result)
if err != nil {
return nil, err
}
@ -275,8 +275,8 @@ func (s *Server) OSBuildJobStatus(id uuid.UUID, result *OSBuildJobResult) (*JobI
return jobInfo, nil
}
func (s *Server) KojiInitJobStatus(id uuid.UUID, result *KojiInitJobResult) (*JobInfo, error) {
jobInfo, err := s.jobStatus(id, result)
func (s *Server) KojiInitJobInfo(id uuid.UUID, result *KojiInitJobResult) (*JobInfo, error) {
jobInfo, err := s.jobInfo(id, result)
if err != nil {
return nil, err
}
@ -292,8 +292,8 @@ func (s *Server) KojiInitJobStatus(id uuid.UUID, result *KojiInitJobResult) (*Jo
return jobInfo, nil
}
func (s *Server) KojiFinalizeJobStatus(id uuid.UUID, result *KojiFinalizeJobResult) (*JobInfo, error) {
jobInfo, err := s.jobStatus(id, result)
func (s *Server) KojiFinalizeJobInfo(id uuid.UUID, result *KojiFinalizeJobResult) (*JobInfo, error) {
jobInfo, err := s.jobInfo(id, result)
if err != nil {
return nil, err
}
@ -309,8 +309,8 @@ func (s *Server) KojiFinalizeJobStatus(id uuid.UUID, result *KojiFinalizeJobResu
return jobInfo, nil
}
func (s *Server) DepsolveJobStatus(id uuid.UUID, result *DepsolveJobResult) (*JobInfo, error) {
jobInfo, err := s.jobStatus(id, result)
func (s *Server) DepsolveJobInfo(id uuid.UUID, result *DepsolveJobResult) (*JobInfo, error) {
jobInfo, err := s.jobInfo(id, result)
if err != nil {
return nil, err
}
@ -330,8 +330,8 @@ func (s *Server) DepsolveJobStatus(id uuid.UUID, result *DepsolveJobResult) (*Jo
return jobInfo, nil
}
func (s *Server) ManifestJobStatus(id uuid.UUID, result *ManifestJobByIDResult) (*JobInfo, error) {
jobInfo, err := s.jobStatus(id, result)
func (s *Server) ManifestJobInfo(id uuid.UUID, result *ManifestJobByIDResult) (*JobInfo, error) {
jobInfo, err := s.jobInfo(id, result)
if err != nil {
return nil, err
}
@ -343,8 +343,8 @@ func (s *Server) ManifestJobStatus(id uuid.UUID, result *ManifestJobByIDResult)
return jobInfo, nil
}
func (s *Server) ContainerResolveJobStatus(id uuid.UUID, result *ContainerResolveJobResult) (*JobInfo, error) {
jobInfo, err := s.jobStatus(id, result)
func (s *Server) ContainerResolveJobInfo(id uuid.UUID, result *ContainerResolveJobResult) (*JobInfo, error) {
jobInfo, err := s.jobInfo(id, result)
if err != nil {
return nil, err
@ -357,7 +357,7 @@ func (s *Server) ContainerResolveJobStatus(id uuid.UUID, result *ContainerResolv
return jobInfo, nil
}
func (s *Server) jobStatus(id uuid.UUID, result interface{}) (*JobInfo, error) {
func (s *Server) jobInfo(id uuid.UUID, result interface{}) (*JobInfo, error) {
jobType, channel, rawResult, queued, started, finished, canceled, deps, err := s.jobs.JobStatus(id)
if err != nil {
return nil, err
@ -415,7 +415,7 @@ func (s *Server) JobType(id uuid.UUID) (string, error) {
}
func (s *Server) Cancel(id uuid.UUID) error {
jobInfo, err := s.jobStatus(id, nil)
jobInfo, err := s.jobInfo(id, nil)
if err != nil {
logrus.Errorf("error getting job status: %v", err)
} else {
@ -431,7 +431,7 @@ func (s *Server) JobArtifact(id uuid.UUID, name string) (io.Reader, int64, error
return nil, 0, errors.New("Artifacts not enabled")
}
jobInfo, err := s.jobStatus(id, nil)
jobInfo, err := s.jobInfo(id, nil)
if err != nil {
return nil, 0, err
}
@ -460,7 +460,7 @@ func (s *Server) DeleteArtifacts(id uuid.UUID) error {
return errors.New("Artifacts not enabled")
}
jobInfo, err := s.jobStatus(id, nil)
jobInfo, err := s.jobInfo(id, nil)
if err != nil {
return err
}
@ -514,7 +514,7 @@ func (s *Server) requestJob(ctx context.Context, arch string, jobTypes []string,
return
}
jobInfo, err := s.jobStatus(jobId, nil)
jobInfo, err := s.jobInfo(jobId, nil)
if err != nil {
logrus.Errorf("error retrieving job status: %v", err)
}
@ -584,7 +584,7 @@ func (s *Server) FinishJob(token uuid.UUID, result json.RawMessage) error {
switch jobType {
case JobTypeOSBuild:
var osbuildJR OSBuildJobResult
jobInfo, err = s.OSBuildJobStatus(jobId, &osbuildJR)
jobInfo, err = s.OSBuildJobInfo(jobId, &osbuildJR)
if err != nil {
return err
}
@ -593,7 +593,7 @@ func (s *Server) FinishJob(token uuid.UUID, result json.RawMessage) error {
case JobTypeDepsolve:
var depsolveJR DepsolveJobResult
jobInfo, err = s.DepsolveJobStatus(jobId, &depsolveJR)
jobInfo, err = s.DepsolveJobInfo(jobId, &depsolveJR)
if err != nil {
return err
}
@ -601,7 +601,7 @@ func (s *Server) FinishJob(token uuid.UUID, result json.RawMessage) error {
case JobTypeManifestIDOnly:
var manifestJR ManifestJobByIDResult
jobInfo, err = s.ManifestJobStatus(jobId, &manifestJR)
jobInfo, err = s.ManifestJobInfo(jobId, &manifestJR)
if err != nil {
return err
}
@ -609,7 +609,7 @@ func (s *Server) FinishJob(token uuid.UUID, result json.RawMessage) error {
case JobTypeKojiInit:
var kojiInitJR KojiInitJobResult
jobInfo, err = s.KojiInitJobStatus(jobId, &kojiInitJR)
jobInfo, err = s.KojiInitJobInfo(jobId, &kojiInitJR)
if err != nil {
return err
}
@ -617,7 +617,7 @@ func (s *Server) FinishJob(token uuid.UUID, result json.RawMessage) error {
case JobTypeKojiFinalize:
var kojiFinalizeJR KojiFinalizeJobResult
jobInfo, err = s.KojiFinalizeJobStatus(jobId, &kojiFinalizeJR)
jobInfo, err = s.KojiFinalizeJobInfo(jobId, &kojiFinalizeJR)
if err != nil {
return err
}
@ -770,7 +770,7 @@ func (h *apiHandlers) GetJob(ctx echo.Context, tokenstr string) error {
h.server.jobs.RefreshHeartbeat(token)
jobInfo, err := h.server.jobStatus(jobId, nil)
jobInfo, err := h.server.jobInfo(jobId, nil)
if err != nil {
return api.HTTPErrorWithInternal(api.ErrorRetrievingJobStatus, err)
}

6
internal/worker/server_test.go
View file

@ -516,7 +516,7 @@ func TestMixedOSBuildJob(t *testing.T) {
require.NoError(err)
oldJobResultRead := new(worker.OSBuildJobResult)
_, err = server.OSBuildJobStatus(oldJobID, oldJobResultRead)
_, err = server.OSBuildJobInfo(oldJobID, oldJobResultRead)
require.NoError(err)
// oldJobResultRead should have PipelineNames now
@ -554,7 +554,7 @@ func TestMixedOSBuildJob(t *testing.T) {
require.NoError(err)
newJobResultRead := new(worker.OSBuildJobResult)
_, err = server.OSBuildJobStatus(newJobID, newJobResultRead)
_, err = server.OSBuildJobInfo(newJobID, newJobResultRead)
require.NoError(err)
require.Equal(newJobResult, newJobResultRead)
}
@ -589,7 +589,7 @@ func TestDepsolveLegacyErrorConversion(t *testing.T) {
ErrorType: errType,
}
_, err = server.DepsolveJobStatus(depsolveJobId, &depsolveJobResult)
_, err = server.DepsolveJobInfo(depsolveJobId, &depsolveJobResult)
require.NoError(t, err)
require.Equal(t, expectedResult, depsolveJobResult)
}