all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Lukas Wagner <l.wagner@proxmox.com>
To: pdm-devel@lists.proxmox.com
Subject: [PATCH datacenter-manager 05/20] pdm-config: remotes: rename trait methods to read/write/lock
Date: Mon, 17 Aug 2026 14:57:12 +0200	[thread overview]
Message-ID: <20260817125727.454039-6-l.wagner@proxmox.com> (raw)
In-Reply-To: <20260817125727.454039-1-l.wagner@proxmox.com>

This makes the use of these less awkward when being called via the trait
object itself, e.g. on a dependency injected application context object:

  app.remote_config().read()
     instead of
  app.remote_config().config()

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 lib/pdm-config/src/remotes.rs          | 24 ++++++++++++------------
 server/src/test_support/fake_remote.rs |  8 ++++----
 2 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/lib/pdm-config/src/remotes.rs b/lib/pdm-config/src/remotes.rs
index a1004cfe..47754e9b 100644
--- a/lib/pdm-config/src/remotes.rs
+++ b/lib/pdm-config/src/remotes.rs
@@ -35,36 +35,36 @@ fn instance() -> &'static (dyn RemoteConfig + Send + Sync) {
 ///
 /// Will panic if the the remote config instance has not been set before.
 pub fn lock_config() -> Result<ApiLockGuard, Error> {
-    instance().lock_config()
+    instance().lock()
 }
 
 /// Return contents of the remotes config
 ///
 /// Will panic if the the remote config instance has not been set before.
 pub fn config() -> Result<(SectionConfigData<Remote>, ConfigDigest), Error> {
-    instance().config()
+    instance().read()
 }
 
 pub fn get_secret_token(remote: &Remote) -> Result<String, Error> {
-    instance().get_secret_token(remote)
+    instance().read_secret_token(remote)
 }
 
 /// Replace the currently persisted remotes config
 ///
 /// Will panic if the the remote config instance has not been set before.
 pub fn save_config(config: SectionConfigData<Remote>) -> Result<(), Error> {
-    instance().save_config(config)
+    instance().write(config)
 }
 
 pub trait RemoteConfig {
     /// Return contents of the remotes config
-    fn config(&self) -> Result<(SectionConfigData<Remote>, ConfigDigest), Error>;
+    fn read(&self) -> Result<(SectionConfigData<Remote>, ConfigDigest), Error>;
     /// Return contents of the remotes shadow config
-    fn get_secret_token(&self, remote: &Remote) -> Result<String, Error>;
+    fn read_secret_token(&self, remote: &Remote) -> Result<String, Error>;
     /// Lock the remotes config
-    fn lock_config(&self) -> Result<ApiLockGuard, Error>;
+    fn lock(&self) -> Result<ApiLockGuard, Error>;
     /// Replace the currently persisted remotes config
-    fn save_config(&self, remotes: SectionConfigData<Remote>) -> Result<(), Error>;
+    fn write(&self, remotes: SectionConfigData<Remote>) -> Result<(), Error>;
 }
 
 /// Default, production implementation for reading/writing the `remotes.cfg`
@@ -72,11 +72,11 @@ pub trait RemoteConfig {
 pub struct DefaultRemoteConfig;
 
 impl RemoteConfig for DefaultRemoteConfig {
-    fn lock_config(&self) -> Result<ApiLockGuard, Error> {
+    fn lock(&self) -> Result<ApiLockGuard, Error> {
         open_api_lockfile(REMOTES_CFG_LOCKFILE, None, true)
     }
 
-    fn config(&self) -> Result<(SectionConfigData<Remote>, ConfigDigest), Error> {
+    fn read(&self) -> Result<(SectionConfigData<Remote>, ConfigDigest), Error> {
         let content =
             proxmox_sys::fs::file_read_optional_string(REMOTES_CFG_FILENAME)?.unwrap_or_default();
 
@@ -86,7 +86,7 @@ impl RemoteConfig for DefaultRemoteConfig {
         Ok((data, digest.into()))
     }
 
-    fn save_config(&self, mut config: SectionConfigData<Remote>) -> Result<(), Error> {
+    fn write(&self, mut config: SectionConfigData<Remote>) -> Result<(), Error> {
         let shadow_content = proxmox_sys::fs::file_read_optional_string(REMOTES_SHADOW_FILENAME)?
             .unwrap_or_default();
 
@@ -135,7 +135,7 @@ impl RemoteConfig for DefaultRemoteConfig {
         replace_config(REMOTES_CFG_FILENAME, raw.as_bytes())
     }
 
-    fn get_secret_token(&self, remote: &Remote) -> Result<String, Error> {
+    fn read_secret_token(&self, remote: &Remote) -> Result<String, Error> {
         // not yet rewritten into shadow config
         if remote.token != "-" {
             return Ok(remote.token.clone());
diff --git a/server/src/test_support/fake_remote.rs b/server/src/test_support/fake_remote.rs
index e13ffa43..f387029f 100644
--- a/server/src/test_support/fake_remote.rs
+++ b/server/src/test_support/fake_remote.rs
@@ -35,7 +35,7 @@ pub struct FakeRemoteConfig {
 }
 
 impl RemoteConfig for FakeRemoteConfig {
-    fn config(&self) -> Result<(SectionConfigData<Remote>, ConfigDigest), Error> {
+    fn read(&self) -> Result<(SectionConfigData<Remote>, ConfigDigest), Error> {
         let mut section_config = SectionConfigData::default();
 
         for i in 0..self.nr_of_pve_remotes {
@@ -59,15 +59,15 @@ impl RemoteConfig for FakeRemoteConfig {
         Ok((section_config, digest))
     }
 
-    fn lock_config(&self) -> Result<ApiLockGuard, Error> {
+    fn lock(&self) -> Result<ApiLockGuard, Error> {
         unsafe { Ok(proxmox_product_config::create_mocked_lock()) }
     }
 
-    fn save_config(&self, _remotes: SectionConfigData<Remote>) -> Result<(), Error> {
+    fn write(&self, _remotes: SectionConfigData<Remote>) -> Result<(), Error> {
         Ok(())
     }
 
-    fn get_secret_token(&self, _remote: &Remote) -> Result<String, Error> {
+    fn read_secret_token(&self, _remote: &Remote) -> Result<String, Error> {
         Ok(String::new())
     }
 }
-- 
2.47.3





  parent reply	other threads:[~2026-08-17 12:57 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-17 12:57 [PATCH datacenter-manager/proxmox 00/20] inject application context via API macro for easier integration testing Lukas Wagner
2026-08-17 12:57 ` [PATCH proxmox 01/20] router: introduce shared state Lukas Wagner
2026-08-17 13:26   ` Lukas Wagner
2026-08-20 11:23   ` Lukas Wagner
2026-08-21 13:59   ` Robert Obkircher
2026-08-17 12:57 ` [PATCH proxmox 02/20] rest-server: allow to inject " Lukas Wagner
2026-08-17 12:57 ` [PATCH proxmox 03/20] api-macro: support shared state extraction type Lukas Wagner
2026-08-21 13:59   ` Robert Obkircher
2026-08-17 12:57 ` [PATCH datacenter-manager 04/20] context: promote context to a dir-style module Lukas Wagner
2026-08-17 12:57 ` Lukas Wagner [this message]
2026-08-17 12:57 ` [PATCH datacenter-manager 06/20] pdm-config: subscriptions: rename trait methods to read/write/lock Lukas Wagner
2026-08-21 14:00   ` Robert Obkircher
2026-08-17 12:57 ` [PATCH datacenter-manager 07/20] remote iterator: pass remote config reader explicitly Lukas Wagner
2026-08-17 12:57 ` [PATCH datacenter-manager 08/20] context: introduce a ContextFactory to build application context Lukas Wagner
2026-08-17 12:57 ` [PATCH datacenter-manager 09/20] context: establish PdmApplication object Lukas Wagner
2026-08-17 12:57 ` [PATCH datacenter-manager 10/20] context: register PdmApplication in router Lukas Wagner
2026-08-17 12:57 ` [PATCH datacenter-manager 11/20] parallel fetcher: pass arguments to closure in a single type Lukas Wagner
2026-08-21 14:00   ` Robert Obkircher
2026-08-17 12:57 ` [PATCH datacenter-manager 12/20] parallel fetcher: support a custom client factory Lukas Wagner
2026-08-17 12:57 ` [PATCH datacenter-manager 13/20] api: sdn: use PdmApplication handle for accessing remotes Lukas Wagner
2026-08-17 12:57 ` [PATCH datacenter-manager 14/20] tests: add helpers for building API-handler-level integration tests Lukas Wagner
2026-08-17 12:57 ` [PATCH datacenter-manager 15/20] tests: add example tests for SDN API routes Lukas Wagner
2026-08-17 12:57 ` [PATCH datacenter-manager 16/20] api-cache: add wrapper type Lukas Wagner
2026-08-17 12:57 ` [PATCH datacenter-manager 17/20] context: provide api-cache on the app object Lukas Wagner
2026-08-17 12:57 ` [PATCH datacenter-manager 18/20] api: subscriptions: use PdmApplication instead of globals Lukas Wagner
2026-08-17 12:57 ` [PATCH datacenter-manager 19/20] pdm-config: subscriptions: drop unused accessor functions Lukas Wagner
2026-08-17 12:57 ` [PATCH datacenter-manager 20/20] tests: add example tests for remote subscription management Lukas Wagner
2026-08-20 14:54 ` superseded: [PATCH datacenter-manager/proxmox 00/20] inject application context via API macro for easier integration testing Lukas Wagner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260817125727.454039-6-l.wagner@proxmox.com \
    --to=l.wagner@proxmox.com \
    --cc=pdm-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal