Prevent downloading templates to secondary storages that are in `read-only` by GaOrtiga · Pull Request #13023 · apache/cloudstack

GaOrtiga · 2026-04-14T13:36:14Z

Description

When a Secondary Storage is marked as read-only, download of new templates is still performed in it. This behavior has been fixed, making it so that read-only storages are ignored during the template download process.

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):

How Has This Been Tested?

I put a secondary in the zone in the read-only state and verified that it no longer would be selected for the download.

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

winterhazel

CLGTM

winterhazel · 2026-04-14T14:10:20Z

@blueorangutan package

blueorangutan · 2026-04-14T14:12:05Z

@winterhazel 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.

blueorangutan · 2026-04-14T14:25:53Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 17486

codecov · 2026-04-14T16:47:06Z

Codecov Report

❌ Patch coverage is 35.71429% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 16.27%. Comparing base (8eb162c) to head (d46b59e).
⚠️ Report is 2 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...dstack/storage/image/BaseImageStoreDriverImpl.java	0.00%	6 Missing ⚠️
.../com/cloud/template/HypervisorTemplateAdapter.java	0.00%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               4.20   #13023   +/-   ##
=========================================
  Coverage     16.26%   16.27%           
- Complexity    13433    13438    +5     
=========================================
  Files          5665     5665           
  Lines        500530   500544   +14     
  Branches      60787    60790    +3     
=========================================
+ Hits          81411    81441   +30     
+ Misses       410027   409997   -30     
- Partials       9092     9106   +14

Flag	Coverage Δ
uitests	`4.15% <ø> (ø)`
unittests	`17.12% <35.71%> (+<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.

sureshanaparti · 2026-04-16T04:45:58Z

@blueorangutan package

blueorangutan · 2026-04-16T04:48:06Z

@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.

blueorangutan · 2026-04-16T05:40:11Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 17514

winterhazel · 2026-04-17T14:25:18Z

@GaOrtiga could you have a look at the test failures?

GaOrtiga · 2026-04-20T11:37:04Z

@blueorangutan package

blueorangutan · 2026-04-20T11:38:04Z

@GaOrtiga 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.

blueorangutan · 2026-04-20T12:25:52Z

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

sureshanaparti · 2026-04-21T05:46:05Z

    @Inject
    StorageOrchestrationService storageOrchestrator;
+    @Inject
+    ImageStoreDao dataStoreDao;


Suggested change

ImageStoreDao dataStoreDao;

ImageStoreDao imageStoreDao;

sureshanaparti · 2026-04-21T05:47:31Z

    }

    protected boolean shouldDownloadTemplateToStore(VMTemplateVO template, DataStore store) {
+        if (dataStoreDao.findById(store.getId()).isReadonly()) {


Suggested change

if (dataStoreDao.findById(store.getId()).isReadonly()) {

ImageStoreVO storeVO = imageStoreDao.findById(store.getId());

if (storeVO == null) {

// add log

return false;

}

if (storeVO.isReadonly()) {

npe for removed image store, can check store exists before isReadonly()

sureshanaparti · 2026-04-21T05:50:52Z

    @Inject
    DataStoreManager dataStoreManager;
+    @Inject
+    ImageStoreDao dataStoreDao;


Suggested change

ImageStoreDao dataStoreDao;

ImageStoreDao imageStoreDao;

sureshanaparti · 2026-04-21T05:51:05Z

+            if (dataStoreDao.findById(dataStore.getId()).isReadonly()) {
+                logger.debug("Template [{}] will not be downloaded to image store [{}] because this store is marked as read-only.", data.getName(),
+                        dataStore.getName());
+                return;


same here

can have a common method to check image store exists or not and then isReadonly() ?

sureshanaparti · 2026-04-21T05:53:01Z

+        if (_imgStoreDao.findById(imageStore.getId()).isReadonly()) {
+            logger.info("Image store [{}] is marked as read-only. Skip downloading template to this image store.", imageStore);
+            return false;
+        }


use common method if possible

Copilot

Pull request overview

Fixes template download/allocation behavior so Secondary Storage marked read-only is skipped during template download and sync flows.

Changes:

Add read-only image store checks when selecting/validating secondary storage for template creation/allocation.
Prevent template sync/download decisions from targeting read-only image stores.
Extend unit tests to account for the new read-only filtering behavior.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
server/src/main/java/com/cloud/template/HypervisorTemplateAdapter.java	Skips template allocation/download to image stores flagged as read-only.
server/src/test/java/com/cloud/template/HypervisorTemplateAdapterTest.java	Updates tests/mocks to support new ImageStoreDao read-only checks.
engine/storage/image/src/main/java/org/apache/cloudstack/storage/image/TemplateServiceImpl.java	Skips downloads during template sync when the target image store is read-only; fixes a log message typo.
engine/storage/image/src/test/java/org/apache/cloudstack/storage/image/TemplateServiceImplTest.java	Adds coverage for read-only store behavior and adjusts setup for new DAO usage.
engine/storage/src/main/java/org/apache/cloudstack/storage/image/BaseImageStoreDriverImpl.java	Avoids downloading templates to read-only image stores at the driver level.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+        ImageStoreVO ImageStoreVOMock = Mockito.mock(ImageStoreVO.class);
        Long zoneId = 1L;
        Set<Long> zoneSet = null;
        boolean isTemplatePrivate = false;
        DataCenterVO dataCenterVOMock = Mockito.mock(DataCenterVO.class);

+        Mockito.when(_imgStoreDao.findById(Mockito.anyLong())).thenReturn(ImageStoreVOMock);


+    @Mock
+    ImageStoreDao imageStore;
+
+    @Mock
+    ImageStoreVO imageMock;
+


+        if (_imgStoreDao.findById(imageStore.getId()).isReadonly()) {
+            logger.info("Image store [{}] is marked as read-only. Skip downloading template to this image store.", imageStore);
+            return false;
+        }


+            if (dataStoreDao.findById(dataStore.getId()).isReadonly()) {
+                logger.debug("Template [{}] will not be downloaded to image store [{}] because this store is marked as read-only.", data.getName(),
+                        dataStore.getName());
+                return;
            }


            return false;
        }

+        if (_imgStoreDao.findById(imageStore.getId()).isReadonly()) {


    protected boolean shouldDownloadTemplateToStore(VMTemplateVO template, DataStore store) {
+        if (dataStoreDao.findById(store.getId()).isReadonly()) {
+            logger.debug("Template [{}] will not be downloaded to image store [{}] because this store is marked as read-only.", template.getUniqueName(),
+                    store.getName());
+            return false;
+        }


dont download templates to read-only storages

0d2f3d6

boring-cyborg bot added the component:storage label Apr 14, 2026

winterhazel approved these changes Apr 14, 2026

View reviewed changes

fix_typos

c6ff0f2

fix tests

d46b59e

sureshanaparti reviewed Apr 21, 2026

View reviewed changes

sureshanaparti requested a review from Copilot April 21, 2026 05:55

Copilot started reviewing on behalf of sureshanaparti April 21, 2026 05:56 View session

Copilot AI reviewed Apr 21, 2026

View reviewed changes

-        if (dataStoreDao.findById(store.getId()).isReadonly()) {
+        ImageStoreVO storeVO = imageStoreDao.findById(store.getId());
+        if (storeVO == null) {
+            // add log
+            return false;
+        }
+        if (storeVO.isReadonly()) {

Conversation

GaOrtiga commented Apr 14, 2026

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!

winterhazel left a comment

Choose a reason for hiding this comment

Uh oh!

winterhazel commented Apr 14, 2026

Uh oh!

blueorangutan commented Apr 14, 2026

Uh oh!

blueorangutan commented Apr 14, 2026

Uh oh!

codecov bot commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sureshanaparti commented Apr 16, 2026

Uh oh!

blueorangutan commented Apr 16, 2026

Uh oh!

blueorangutan commented Apr 16, 2026

Uh oh!

winterhazel commented Apr 17, 2026

Uh oh!

GaOrtiga commented Apr 20, 2026

Uh oh!

blueorangutan commented Apr 20, 2026

Uh oh!

blueorangutan commented Apr 20, 2026

Uh oh!

sureshanaparti Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

sureshanaparti Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

sureshanaparti Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

sureshanaparti Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sureshanaparti Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Apr 14, 2026 •

edited

Loading

sureshanaparti Apr 21, 2026 •

edited

Loading