diff --git a/addon/flamenco/job_types.py b/addon/flamenco/job_types.py index 0b89c70d..69a855bd 100644 --- a/addon/flamenco/job_types.py +++ b/addon/flamenco/job_types.py @@ -116,7 +116,8 @@ def _store_available_job_types(available_job_types: _AvailableJobTypes) -> None: else: # Convert from API response type to list suitable for an EnumProperty. _job_type_enum_items = [ - (job_type.name, job_type.label, "") for job_type in job_types + (job_type.name, job_type.label, getattr(job_type, "description", "")) + for job_type in job_types ] _job_type_enum_items.insert(0, _JOB_TYPE_NOT_SELECTED_ENUM_ITEM) diff --git a/internal/manager/api_impl/jobs_test.go b/internal/manager/api_impl/jobs_test.go index ea26e9a5..61b52327 100644 --- a/internal/manager/api_impl/jobs_test.go +++ b/internal/manager/api_impl/jobs_test.go @@ -442,6 +442,32 @@ func TestGetJobTypeHappy(t *testing.T) { assertResponseJSON(t, echoCtx, http.StatusOK, jt) } +func TestGetJobTypeWithDescriptionHappy(t *testing.T) { + mockCtrl := gomock.NewController(t) + defer mockCtrl.Finish() + mf := newMockedFlamenco(mockCtrl) + + // Get an existing job type with a description. + description := "This is a test job type" + jt := api.AvailableJobType{ + Description: &description, + Etag: "some etag", + Name: "test-job-type", + Label: "Test Job Type", + Settings: []api.AvailableJobSetting{ + {Key: "setting", Type: api.AvailableJobSettingTypeString}, + }, + } + mf.jobCompiler.EXPECT().GetJobType("test-job-type"). + Return(jt, nil) + + echoCtx := mf.prepareMockedRequest(nil) + err := mf.flamenco.GetJobType(echoCtx, "test-job-type") + require.NoError(t, err) + + assertResponseJSON(t, echoCtx, http.StatusOK, jt) +} + func TestGetJobTypeUnknown(t *testing.T) { mockCtrl := gomock.NewController(t) defer mockCtrl.Finish() diff --git a/internal/manager/job_compilers/scripts-for-unittest/simple_blender_render.js b/internal/manager/job_compilers/scripts-for-unittest/simple_blender_render.js index cbe73256..157e534b 100644 --- a/internal/manager/job_compilers/scripts-for-unittest/simple_blender_render.js +++ b/internal/manager/job_compilers/scripts-for-unittest/simple_blender_render.js @@ -2,6 +2,7 @@ const JOB_TYPE = { label: "Simple Blender Render", + description: "Render a sequence of frames, and create a preview video file", settings: [ // Settings for artists to determine: { key: "frames", type: "string", required: true, eval: "f'{C.scene.frame_start}-{C.scene.frame_end}'", diff --git a/internal/manager/job_compilers/scripts/simple_blender_render.js b/internal/manager/job_compilers/scripts/simple_blender_render.js index d4a18672..3c6f4123 100644 --- a/internal/manager/job_compilers/scripts/simple_blender_render.js +++ b/internal/manager/job_compilers/scripts/simple_blender_render.js @@ -2,6 +2,7 @@ const JOB_TYPE = { label: "Simple Blender Render", + description: "Render a sequence of frames, and create a preview video file", settings: [ // Settings for artists to determine: { key: "frames", type: "string", required: true,