Support to list templates in ready state (new API parameter 'isready', similar to list ISOs) by sureshanaparti · Pull Request #11343 · apache/cloudstack

sureshanaparti · 2025-07-30T09:05:11Z

Description

This PR adds support to list templates in ready state (new API parameter 'isready', similar to list ISOs), and UI to display Templates/ISOs in ready state wherever applicable.

The latest UI in main uses templatefilter 'all' and oscategoryid to list the templates, which is listing not ready templates as well. Earlier UI listed the templates using the appropriate templatefilters (featured, executable, selfexecutable) which lists only ready templates.

Fixes #11339

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI
test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

List ISOs

List ISOs in Deploy Instance Form

List Templates

List Templates in Deploy Instance Form

How Has This Been Tested?

Verified list templates / ISOs call while registering new template / ISO.

(localcloud) 🐱 > list isos isofilter=all bootable=true filter=id,name,status,isready,ostypename
{
  "count": 2,
  "iso": [
    {
      "id": "852ad01e-96cd-4488-94ca-878d2a473222",
      "isready": true,
      "name": "CentOS-7",
      "ostypename": "CentOS 7",
      "status": "Successfully Installed"
    },
    {
      "id": "862cc57a-ada0-45aa-9c60-8e55c59ef4c3",
      "isready": false,
      "name": "CentOS-7-NewISO",
      "ostypename": "CentOS 7",
      "status": "26% Downloaded"
    }
  ]
}

(localcloud) 🐱 > list isos isofilter=all bootable=true isready=true filter=id,name,status,isready,ostypename
{
  "count": 1,
  "iso": [
    {
      "id": "852ad01e-96cd-4488-94ca-878d2a473222",
      "isready": true,
      "name": "CentOS-7",
      "ostypename": "CentOS 7",
      "status": "Successfully Installed"
    }
  ]
}

(localcloud) 🐱 > list templates templatefilter=all filter=id,name,status,isready,ostypename
{
  "count": 4,
  "template": [
    {
      "id": "a4a63917-26e5-4840-b5b5-089464200f41",
      "isready": true,
      "name": "centos7",
      "ostypename": "CentOS 7",
      "status": "Download Complete"
    },
    {
      "id": "20f0bc6e-ca82-4421-9840-378bb0756064",
      "isready": false,
      "name": "CentOS-7-NewTmpl",
      "ostypename": "CentOS 7",
      "status": "19% Downloaded"
    },
    {
      "id": "b880c853-6d39-11f0-aba0-1e004200030e",
      "isready": true,
      "name": "SystemVM Template (KVM)",
      "ostypename": "Debian GNU/Linux 5.0 (64-bit)",
      "status": "Download Complete"
    },
    {
      "id": "b88233a8-6d39-11f0-aba0-1e004200030e",
      "isready": true,
      "name": "CentOS 5.5(64-bit) no GUI (KVM)",
      "ostypename": "CentOS 5.5 (64-bit)",
      "status": "Download Complete"
    }
  ]
}

(localcloud) 🐱 > list templates templatefilter=all isready=true filter=id,name,status,isready,ostypename
{
  "count": 3,
  "template": [
    {
      "id": "a4a63917-26e5-4840-b5b5-089464200f41",
      "isready": true,
      "name": "centos7",
      "ostypename": "CentOS 7",
      "status": "Download Complete"
    },
    {
      "id": "b880c853-6d39-11f0-aba0-1e004200030e",
      "isready": true,
      "name": "SystemVM Template (KVM)",
      "ostypename": "Debian GNU/Linux 5.0 (64-bit)",
      "status": "Download Complete"
    },
    {
      "id": "b88233a8-6d39-11f0-aba0-1e004200030e",
      "isready": true,
      "name": "CentOS 5.5(64-bit) no GUI (KVM)",
      "ostypename": "CentOS 5.5 (64-bit)",
      "status": "Download Complete"
    }
  ]
}

How did you try to break this feature and the system with this change?

sureshanaparti · 2025-07-30T09:08:04Z

@blueorangutan package

blueorangutan · 2025-07-30T09:10:04Z

@sureshanaparti a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

codecov · 2025-07-30T09:13:20Z

Codecov Report

❌ Patch coverage is 0% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.17%. Comparing base (86827f8) to head (9c6837a).
⚠️ Report is 127 commits behind head on main.

Files with missing lines	Patch %	Lines
...ck/api/command/user/template/ListTemplatesCmd.java	0.00%	6 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##               main   #11343    +/-   ##
==========================================
  Coverage     17.17%   17.17%            
- Complexity    14985    15007    +22     
==========================================
  Files          5869     5869            
  Lines        521590   521727   +137     
  Branches      63485    63511    +26     
==========================================
+ Hits          89562    89604    +42     
- Misses       421962   422066   +104     
+ Partials      10066    10057     -9

Flag	Coverage Δ
uitests	`3.75% <ø> (+<0.01%)`	⬆️
unittests	`18.15% <0.00%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

blueorangutan · 2025-07-30T11:18:10Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 14467

DaanHoogland

clgtm

…, similar to list ISOs), and UI to display Templates/ISOs in ready state wherever applicable

sureshanaparti · 2025-07-30T13:57:07Z

@blueorangutan package

blueorangutan · 2025-07-30T13:58:04Z

@sureshanaparti a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

ui/src/views/compute/AutoScaleVmProfile.vue

sureshanaparti · 2025-07-30T14:12:01Z

@blueorangutan ui

blueorangutan · 2025-07-30T14:13:04Z

@sureshanaparti a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress.

blueorangutan · 2025-07-30T14:31:44Z

UI build: ✔️
Live QA URL: https://qa.cloudstack.cloud/simulator/pr/11343 (QA-JID-706)

blueorangutan · 2025-07-30T15:21:03Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 14474

slavkap

Thanks, @sureshanaparti, for the fix!
Code LGTM

kiranchavala

LGTM, verified manually

Marked a template as Not Ready state in template_store_ref table

The template was not listed in deploy vm wizard

…, similar to list ISOs) (apache#11343) * Support to list templates in ready state (new API parameter 'isready', similar to list ISOs), and UI to display Templates/ISOs in ready state wherever applicable

boring-cyborg bot added component:api component:UI labels Jul 30, 2025

sureshanaparti linked an issue Jul 30, 2025 that may be closed by this pull request

UI - Not downloaded templates are shown on deploy new instance #11339

Closed

sureshanaparti added this to the 4.21.0 milestone Jul 30, 2025

sureshanaparti added this to Apache CloudStack 4.21.0 Jul 30, 2025

sureshanaparti moved this to In Progress in Apache CloudStack 4.21.0 Jul 30, 2025

DaanHoogland approved these changes Jul 30, 2025

View reviewed changes

Support to list templates in ready state (new API parameter 'isready'…

840c713

…, similar to list ISOs), and UI to display Templates/ISOs in ready state wherever applicable

sureshanaparti force-pushed the list-templates-in-ready-state branch from 1085330 to 840c713 Compare July 30, 2025 13:46

sureshanaparti marked this pull request as ready for review July 30, 2025 13:56

sureshanaparti requested review from shwstppr, slavkap and vishesh92 July 30, 2025 14:09

sureshanaparti commented Jul 30, 2025

View reviewed changes

ui/src/views/compute/AutoScaleVmProfile.vue Outdated Show resolved Hide resolved

Update ui/src/views/compute/AutoScaleVmProfile.vue

9c6837a

slavkap approved these changes Jul 30, 2025

View reviewed changes

kiranchavala approved these changes Jul 31, 2025

View reviewed changes

sureshanaparti merged commit 1f1e38f into apache:main Jul 31, 2025
23 of 26 checks passed

github-project-automation bot moved this from In Progress to Done in Apache CloudStack 4.21.0 Jul 31, 2025

sureshanaparti deleted the list-templates-in-ready-state branch July 31, 2025 04:38

sureshanaparti mentioned this pull request Jul 31, 2025

UI - Not downloaded templates are shown on deploy new instance #11339

Closed

sureshanaparti added the type:improvement label Aug 20, 2025

Conversation

sureshanaparti commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

sureshanaparti commented Jul 30, 2025

Uh oh!

blueorangutan commented Jul 30, 2025

Uh oh!

codecov bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Jul 30, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

sureshanaparti commented Jul 30, 2025

Uh oh!

blueorangutan commented Jul 30, 2025

Uh oh!

Uh oh!

sureshanaparti commented Jul 30, 2025

Uh oh!

blueorangutan commented Jul 30, 2025

Uh oh!

blueorangutan commented Jul 30, 2025

Uh oh!

blueorangutan commented Jul 30, 2025

Uh oh!

slavkap left a comment

Choose a reason for hiding this comment

Uh oh!

kiranchavala left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

sureshanaparti commented Jul 30, 2025 •

edited

Loading

codecov bot commented Jul 30, 2025 •

edited

Loading