fix(config): implement atomic save, validation and recovery for config files and update pdoc

This commit is contained in:
fluzzi32 committed 2026-04-04 10:55:05 -03:00
1 parent 24f98885c0
commit af85051eb7
7 files changed
+984 -65

No files matched your search

+8 -8
View File
@@ -58,7 +58,7 @@ No test touches ~/.config/conn/</p>
<pre><code class="python">@pytest.fixture
def ai_config(tmp_config_dir):
&#34;&#34;&#34;Create a configfile with AI keys configured for AI tests.&#34;&#34;&#34;
config_file = tmp_config_dir / &#34;config.json&#34;
config_file = tmp_config_dir / &#34;config.yaml&#34;
data = {
&#34;config&#34;: {
&#34;case&#34;: False, &#34;idletime&#34;: 30, &#34;fzf&#34;: False,
@@ -72,7 +72,7 @@ def ai_config(tmp_config_dir):
&#34;connections&#34;: SAMPLE_CONNECTIONS,
&#34;profiles&#34;: SAMPLE_PROFILES
}
config_file.write_text(json.dumps(data, indent=4))
config_file.write_text(yaml.dump(data, default_flow_style=False, sort_keys=False))
from connpy.configfile import configfile
return configfile(conf=str(config_file), key=str(tmp_config_dir / &#34;.osk&#34;))</code></pre>
</details>
@@ -90,7 +90,7 @@ def ai_config(tmp_config_dir):
def config(tmp_config_dir):
&#34;&#34;&#34;Create a configfile instance pointing to tmp directory.&#34;&#34;&#34;
from connpy.configfile import configfile
conf_path = str(tmp_config_dir / &#34;config.json&#34;)
conf_path = str(tmp_config_dir / &#34;config.yaml&#34;)
key_path = str(tmp_config_dir / &#34;.osk&#34;)
return configfile(conf=conf_path, key=key_path)</code></pre>
</details>
@@ -182,13 +182,13 @@ def mock_pexpect():
<pre><code class="python">@pytest.fixture
def populated_config(tmp_config_dir):
&#34;&#34;&#34;Create a configfile with sample nodes/profiles pre-loaded.&#34;&#34;&#34;
config_file = tmp_config_dir / &#34;config.json&#34;
config_file = tmp_config_dir / &#34;config.yaml&#34;
data = {
&#34;config&#34;: {&#34;case&#34;: False, &#34;idletime&#34;: 30, &#34;fzf&#34;: False},
&#34;connections&#34;: SAMPLE_CONNECTIONS,
&#34;profiles&#34;: SAMPLE_PROFILES
}
config_file.write_text(json.dumps(data, indent=4))
config_file.write_text(yaml.dump(data, default_flow_style=False, sort_keys=False))
from connpy.configfile import configfile
return configfile(conf=str(config_file), key=str(tmp_config_dir / &#34;.osk&#34;))</code></pre>
</details>
@@ -210,9 +210,9 @@ def tmp_config_dir(tmp_path):
plugins_dir = config_dir / &#34;plugins&#34;
plugins_dir.mkdir()
# Write config.json
config_file = config_dir / &#34;config.json&#34;
config_file.write_text(json.dumps(DEFAULT_CONFIG, indent=4))
# Write config.yaml
config_file = config_dir / &#34;config.yaml&#34;
config_file.write_text(yaml.dump(DEFAULT_CONFIG, default_flow_style=False, sort_keys=False))
os.chmod(str(config_file), 0o600)
# Write .folder (points to itself)
+606
View File
@@ -47,6 +47,116 @@ el.replaceWith(d);
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="connpy.tests.test_configfile.TestAtomicSave"><code class="flex name class">
<span>class <span class="ident">TestAtomicSave</span></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class TestAtomicSave:
def test_save_creates_no_leftover_tmp(self, config):
&#34;&#34;&#34;After successful save, no .tmp file remains.&#34;&#34;&#34;
config._connections_add(
id=&#34;test123&#34;, host=&#34;1.2.3.4&#34;, protocol=&#34;ssh&#34;,
port=&#34;&#34;, user=&#34;&#34;, password=&#34;&#34;, options=&#34;&#34;,
logs=&#34;&#34;, tags=&#34;&#34;, jumphost=&#34;&#34;
)
result = config._saveconfig(config.file)
assert result == 0
assert not os.path.exists(config.file + &#39;.tmp&#39;)
def test_save_preserves_original_on_error(self, config):
&#34;&#34;&#34;If save fails, original config file is not corrupted.&#34;&#34;&#34;
import unittest.mock as mock
config._connections_add(
id=&#34;original_node&#34;, host=&#34;10.0.0.1&#34;, protocol=&#34;ssh&#34;,
port=&#34;&#34;, user=&#34;&#34;, password=&#34;&#34;, options=&#34;&#34;,
logs=&#34;&#34;, tags=&#34;&#34;, jumphost=&#34;&#34;
)
config._saveconfig(config.file)
# Now add another node and make yaml.dump fail
config._connections_add(
id=&#34;new_node&#34;, host=&#34;10.0.0.2&#34;, protocol=&#34;ssh&#34;,
port=&#34;&#34;, user=&#34;&#34;, password=&#34;&#34;, options=&#34;&#34;,
logs=&#34;&#34;, tags=&#34;&#34;, jumphost=&#34;&#34;
)
with mock.patch(&#39;connpy.configfile.yaml.dump&#39;, side_effect=IOError(&#34;disk full&#34;)):
result = config._saveconfig(config.file)
assert result == 1
# Original file should still be valid with original_node
from connpy.configfile import configfile
reloaded = configfile(conf=config.file, key=config.key)
assert &#34;original_node&#34; in reloaded.connections</code></pre>
</details>
<div class="desc"></div>
<h3>Methods</h3>
<dl>
<dt id="connpy.tests.test_configfile.TestAtomicSave.test_save_creates_no_leftover_tmp"><code class="name flex">
<span>def <span class="ident">test_save_creates_no_leftover_tmp</span></span>(<span>self, config)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_save_creates_no_leftover_tmp(self, config):
&#34;&#34;&#34;After successful save, no .tmp file remains.&#34;&#34;&#34;
config._connections_add(
id=&#34;test123&#34;, host=&#34;1.2.3.4&#34;, protocol=&#34;ssh&#34;,
port=&#34;&#34;, user=&#34;&#34;, password=&#34;&#34;, options=&#34;&#34;,
logs=&#34;&#34;, tags=&#34;&#34;, jumphost=&#34;&#34;
)
result = config._saveconfig(config.file)
assert result == 0
assert not os.path.exists(config.file + &#39;.tmp&#39;)</code></pre>
</details>
<div class="desc"><p>After successful save, no .tmp file remains.</p></div>
</dd>
<dt id="connpy.tests.test_configfile.TestAtomicSave.test_save_preserves_original_on_error"><code class="name flex">
<span>def <span class="ident">test_save_preserves_original_on_error</span></span>(<span>self, config)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_save_preserves_original_on_error(self, config):
&#34;&#34;&#34;If save fails, original config file is not corrupted.&#34;&#34;&#34;
import unittest.mock as mock
config._connections_add(
id=&#34;original_node&#34;, host=&#34;10.0.0.1&#34;, protocol=&#34;ssh&#34;,
port=&#34;&#34;, user=&#34;&#34;, password=&#34;&#34;, options=&#34;&#34;,
logs=&#34;&#34;, tags=&#34;&#34;, jumphost=&#34;&#34;
)
config._saveconfig(config.file)
# Now add another node and make yaml.dump fail
config._connections_add(
id=&#34;new_node&#34;, host=&#34;10.0.0.2&#34;, protocol=&#34;ssh&#34;,
port=&#34;&#34;, user=&#34;&#34;, password=&#34;&#34;, options=&#34;&#34;,
logs=&#34;&#34;, tags=&#34;&#34;, jumphost=&#34;&#34;
)
with mock.patch(&#39;connpy.configfile.yaml.dump&#39;, side_effect=IOError(&#34;disk full&#34;)):
result = config._saveconfig(config.file)
assert result == 1
# Original file should still be valid with original_node
from connpy.configfile import configfile
reloaded = configfile(conf=config.file, key=config.key)
assert &#34;original_node&#34; in reloaded.connections</code></pre>
</details>
<div class="desc"><p>If save fails, original config file is not corrupted.</p></div>
</dd>
</dl>
</dd>
<dt id="connpy.tests.test_configfile.TestCRUDNodes"><code class="flex name class">
<span>class <span class="ident">TestCRUDNodes</span></span>
</code></dt>
@@ -565,6 +675,210 @@ el.replaceWith(d);
</dd>
</dl>
</dd>
<dt id="connpy.tests.test_configfile.TestCorruptionRecovery"><code class="flex name class">
<span>class <span class="ident">TestCorruptionRecovery</span></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class TestCorruptionRecovery:
def test_corrupt_yaml_recovers_from_cache(self, tmp_config_dir):
&#34;&#34;&#34;If YAML is corrupt but cache is valid, recovers from cache.&#34;&#34;&#34;
config_file = tmp_config_dir / &#34;config.yaml&#34;
key_file = tmp_config_dir / &#34;.osk&#34;
# Write valid config with router1
valid_data = {
&#34;config&#34;: {&#34;case&#34;: False, &#34;idletime&#34;: 30, &#34;fzf&#34;: False},
&#34;connections&#34;: {&#34;router1&#34;: {&#34;host&#34;: &#34;10.0.0.1&#34;, &#34;type&#34;: &#34;connection&#34;, &#34;protocol&#34;: &#34;ssh&#34;, &#34;port&#34;: &#34;&#34;, &#34;user&#34;: &#34;&#34;, &#34;password&#34;: &#34;&#34;, &#34;options&#34;: &#34;&#34;, &#34;logs&#34;: &#34;&#34;, &#34;tags&#34;: &#34;&#34;, &#34;jumphost&#34;: &#34;&#34;}},
&#34;profiles&#34;: {&#34;default&#34;: {&#34;host&#34;: &#34;&#34;, &#34;protocol&#34;: &#34;ssh&#34;, &#34;port&#34;: &#34;&#34;, &#34;user&#34;: &#34;&#34;, &#34;password&#34;: &#34;&#34;, &#34;options&#34;: &#34;&#34;, &#34;logs&#34;: &#34;&#34;, &#34;tags&#34;: &#34;&#34;, &#34;jumphost&#34;: &#34;&#34;}}
}
config_file.write_text(yaml.dump(valid_data, default_flow_style=False, sort_keys=False))
from connpy.configfile import configfile
conf = configfile(conf=str(config_file), key=str(key_file))
# Save to populate cache at the real self.cachefile path
conf._saveconfig(conf.file)
cachefile_path = conf.cachefile
assert os.path.exists(cachefile_path)
# Now corrupt the YAML
config_file.write_text(&#34;&#34;)
import time; time.sleep(0.05) # Ensure YAML is newer than cache
# Reload - should recover from cache
conf2 = configfile(conf=str(config_file), key=str(key_file))
assert &#34;router1&#34; in conf2.connections
assert conf2.connections[&#34;router1&#34;][&#34;host&#34;] == &#34;10.0.0.1&#34;
def test_corrupt_cache_uses_yaml(self, tmp_config_dir):
&#34;&#34;&#34;If cache is corrupt but YAML is valid, uses YAML.&#34;&#34;&#34;
config_file = tmp_config_dir / &#34;config.yaml&#34;
key_file = tmp_config_dir / &#34;.osk&#34;
valid_data = {
&#34;config&#34;: {&#34;case&#34;: False, &#34;idletime&#34;: 30, &#34;fzf&#34;: False},
&#34;connections&#34;: {},
&#34;profiles&#34;: {&#34;default&#34;: {&#34;host&#34;: &#34;&#34;, &#34;protocol&#34;: &#34;ssh&#34;, &#34;port&#34;: &#34;&#34;, &#34;user&#34;: &#34;&#34;, &#34;password&#34;: &#34;&#34;, &#34;options&#34;: &#34;&#34;, &#34;logs&#34;: &#34;&#34;, &#34;tags&#34;: &#34;&#34;, &#34;jumphost&#34;: &#34;&#34;}}
}
config_file.write_text(yaml.dump(valid_data, default_flow_style=False, sort_keys=False))
from connpy.configfile import configfile
conf = configfile(conf=str(config_file), key=str(key_file))
cachefile_path = conf.cachefile
# Now corrupt the cache (valid JSON but invalid config structure)
from pathlib import Path
Path(cachefile_path).write_text(json.dumps({&#34;garbage&#34;: True}))
# Make cache newer than YAML to force cache path
import time; time.sleep(0.05)
os.utime(cachefile_path, None)
conf2 = configfile(conf=str(config_file), key=str(key_file))
assert conf2.config[&#34;case&#34;] == False
assert &#34;default&#34; in conf2.profiles
def test_both_corrupt_creates_default(self, tmp_config_dir):
&#34;&#34;&#34;If both YAML and cache are corrupt, creates fresh config.&#34;&#34;&#34;
config_file = tmp_config_dir / &#34;config.yaml&#34;
key_file = tmp_config_dir / &#34;.osk&#34;
from connpy.configfile import configfile
conf = configfile(conf=str(config_file), key=str(key_file))
cachefile_path = conf.cachefile
# Corrupt YAML
config_file.write_text(&#34;&#34;)
# Corrupt cache
from pathlib import Path
Path(cachefile_path).write_text(json.dumps({&#34;garbage&#34;: True}))
import time; time.sleep(0.05)
os.utime(str(config_file), None)
conf2 = configfile(conf=str(config_file), key=str(key_file))
# Should get defaults, not crash
assert conf2.config is not None
assert &#34;default&#34; in conf2.profiles
assert isinstance(conf2.connections, dict)</code></pre>
</details>
<div class="desc"></div>
<h3>Methods</h3>
<dl>
<dt id="connpy.tests.test_configfile.TestCorruptionRecovery.test_both_corrupt_creates_default"><code class="name flex">
<span>def <span class="ident">test_both_corrupt_creates_default</span></span>(<span>self, tmp_config_dir)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_both_corrupt_creates_default(self, tmp_config_dir):
&#34;&#34;&#34;If both YAML and cache are corrupt, creates fresh config.&#34;&#34;&#34;
config_file = tmp_config_dir / &#34;config.yaml&#34;
key_file = tmp_config_dir / &#34;.osk&#34;
from connpy.configfile import configfile
conf = configfile(conf=str(config_file), key=str(key_file))
cachefile_path = conf.cachefile
# Corrupt YAML
config_file.write_text(&#34;&#34;)
# Corrupt cache
from pathlib import Path
Path(cachefile_path).write_text(json.dumps({&#34;garbage&#34;: True}))
import time; time.sleep(0.05)
os.utime(str(config_file), None)
conf2 = configfile(conf=str(config_file), key=str(key_file))
# Should get defaults, not crash
assert conf2.config is not None
assert &#34;default&#34; in conf2.profiles
assert isinstance(conf2.connections, dict)</code></pre>
</details>
<div class="desc"><p>If both YAML and cache are corrupt, creates fresh config.</p></div>
</dd>
<dt id="connpy.tests.test_configfile.TestCorruptionRecovery.test_corrupt_cache_uses_yaml"><code class="name flex">
<span>def <span class="ident">test_corrupt_cache_uses_yaml</span></span>(<span>self, tmp_config_dir)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_corrupt_cache_uses_yaml(self, tmp_config_dir):
&#34;&#34;&#34;If cache is corrupt but YAML is valid, uses YAML.&#34;&#34;&#34;
config_file = tmp_config_dir / &#34;config.yaml&#34;
key_file = tmp_config_dir / &#34;.osk&#34;
valid_data = {
&#34;config&#34;: {&#34;case&#34;: False, &#34;idletime&#34;: 30, &#34;fzf&#34;: False},
&#34;connections&#34;: {},
&#34;profiles&#34;: {&#34;default&#34;: {&#34;host&#34;: &#34;&#34;, &#34;protocol&#34;: &#34;ssh&#34;, &#34;port&#34;: &#34;&#34;, &#34;user&#34;: &#34;&#34;, &#34;password&#34;: &#34;&#34;, &#34;options&#34;: &#34;&#34;, &#34;logs&#34;: &#34;&#34;, &#34;tags&#34;: &#34;&#34;, &#34;jumphost&#34;: &#34;&#34;}}
}
config_file.write_text(yaml.dump(valid_data, default_flow_style=False, sort_keys=False))
from connpy.configfile import configfile
conf = configfile(conf=str(config_file), key=str(key_file))
cachefile_path = conf.cachefile
# Now corrupt the cache (valid JSON but invalid config structure)
from pathlib import Path
Path(cachefile_path).write_text(json.dumps({&#34;garbage&#34;: True}))
# Make cache newer than YAML to force cache path
import time; time.sleep(0.05)
os.utime(cachefile_path, None)
conf2 = configfile(conf=str(config_file), key=str(key_file))
assert conf2.config[&#34;case&#34;] == False
assert &#34;default&#34; in conf2.profiles</code></pre>
</details>
<div class="desc"><p>If cache is corrupt but YAML is valid, uses YAML.</p></div>
</dd>
<dt id="connpy.tests.test_configfile.TestCorruptionRecovery.test_corrupt_yaml_recovers_from_cache"><code class="name flex">
<span>def <span class="ident">test_corrupt_yaml_recovers_from_cache</span></span>(<span>self, tmp_config_dir)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_corrupt_yaml_recovers_from_cache(self, tmp_config_dir):
&#34;&#34;&#34;If YAML is corrupt but cache is valid, recovers from cache.&#34;&#34;&#34;
config_file = tmp_config_dir / &#34;config.yaml&#34;
key_file = tmp_config_dir / &#34;.osk&#34;
# Write valid config with router1
valid_data = {
&#34;config&#34;: {&#34;case&#34;: False, &#34;idletime&#34;: 30, &#34;fzf&#34;: False},
&#34;connections&#34;: {&#34;router1&#34;: {&#34;host&#34;: &#34;10.0.0.1&#34;, &#34;type&#34;: &#34;connection&#34;, &#34;protocol&#34;: &#34;ssh&#34;, &#34;port&#34;: &#34;&#34;, &#34;user&#34;: &#34;&#34;, &#34;password&#34;: &#34;&#34;, &#34;options&#34;: &#34;&#34;, &#34;logs&#34;: &#34;&#34;, &#34;tags&#34;: &#34;&#34;, &#34;jumphost&#34;: &#34;&#34;}},
&#34;profiles&#34;: {&#34;default&#34;: {&#34;host&#34;: &#34;&#34;, &#34;protocol&#34;: &#34;ssh&#34;, &#34;port&#34;: &#34;&#34;, &#34;user&#34;: &#34;&#34;, &#34;password&#34;: &#34;&#34;, &#34;options&#34;: &#34;&#34;, &#34;logs&#34;: &#34;&#34;, &#34;tags&#34;: &#34;&#34;, &#34;jumphost&#34;: &#34;&#34;}}
}
config_file.write_text(yaml.dump(valid_data, default_flow_style=False, sort_keys=False))
from connpy.configfile import configfile
conf = configfile(conf=str(config_file), key=str(key_file))
# Save to populate cache at the real self.cachefile path
conf._saveconfig(conf.file)
cachefile_path = conf.cachefile
assert os.path.exists(cachefile_path)
# Now corrupt the YAML
config_file.write_text(&#34;&#34;)
import time; time.sleep(0.05) # Ensure YAML is newer than cache
# Reload - should recover from cache
conf2 = configfile(conf=str(config_file), key=str(key_file))
assert &#34;router1&#34; in conf2.connections
assert conf2.connections[&#34;router1&#34;][&#34;host&#34;] == &#34;10.0.0.1&#34;</code></pre>
</details>
<div class="desc"><p>If YAML is corrupt but cache is valid, recovers from cache.</p></div>
</dd>
</dl>
</dd>
<dt id="connpy.tests.test_configfile.TestEncryption"><code class="flex name class">
<span>class <span class="ident">TestEncryption</span></span>
</code></dt>
@@ -1297,6 +1611,266 @@ el.replaceWith(d);
</dd>
</dl>
</dd>
<dt id="connpy.tests.test_configfile.TestMigrationSafety"><code class="flex name class">
<span>class <span class="ident">TestMigrationSafety</span></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class TestMigrationSafety:
def test_migration_validates_legacy_data(self, tmp_path):
&#34;&#34;&#34;Migration skips invalid legacy JSON files.&#34;&#34;&#34;
from unittest.mock import patch
config_dir = tmp_path / &#34;.config&#34; / &#34;conn&#34;
config_dir.mkdir(parents=True)
(config_dir / &#34;plugins&#34;).mkdir()
# Write .folder
(config_dir / &#34;.folder&#34;).write_text(str(config_dir))
# Generate RSA key
from Crypto.PublicKey import RSA
key = RSA.generate(2048)
key_file = config_dir / &#34;.osk&#34;
key_file.write_bytes(key.export_key(&#34;PEM&#34;))
os.chmod(str(key_file), 0o600)
# Write invalid JSON config (missing required keys)
legacy_file = config_dir / &#34;config.json&#34;
legacy_file.write_text(json.dumps({&#34;garbage&#34;: True}))
with patch(&#34;os.path.expanduser&#34;, return_value=str(tmp_path)):
from connpy.configfile import configfile
conf = configfile(key=str(key_file))
# Legacy file should NOT have been moved to .backup
assert legacy_file.exists()
assert not (config_dir / &#34;config.json.backup&#34;).exists()
def test_migration_verifies_written_yaml(self, tmp_path):
&#34;&#34;&#34;Migration succeeds when legacy JSON is valid.&#34;&#34;&#34;
from unittest.mock import patch
config_dir = tmp_path / &#34;.config&#34; / &#34;conn&#34;
config_dir.mkdir(parents=True)
(config_dir / &#34;plugins&#34;).mkdir()
# Write .folder
(config_dir / &#34;.folder&#34;).write_text(str(config_dir))
# Generate RSA key
from Crypto.PublicKey import RSA
key = RSA.generate(2048)
key_file = config_dir / &#34;.osk&#34;
key_file.write_bytes(key.export_key(&#34;PEM&#34;))
os.chmod(str(key_file), 0o600)
valid_data = {
&#34;config&#34;: {&#34;case&#34;: False, &#34;idletime&#34;: 30, &#34;fzf&#34;: False},
&#34;connections&#34;: {&#34;r1&#34;: {&#34;host&#34;: &#34;1.2.3.4&#34;, &#34;type&#34;: &#34;connection&#34;, &#34;protocol&#34;: &#34;ssh&#34;, &#34;port&#34;: &#34;&#34;, &#34;user&#34;: &#34;&#34;, &#34;password&#34;: &#34;&#34;, &#34;options&#34;: &#34;&#34;, &#34;logs&#34;: &#34;&#34;, &#34;tags&#34;: &#34;&#34;, &#34;jumphost&#34;: &#34;&#34;}},
&#34;profiles&#34;: {&#34;default&#34;: {&#34;host&#34;: &#34;&#34;, &#34;protocol&#34;: &#34;ssh&#34;, &#34;port&#34;: &#34;&#34;, &#34;user&#34;: &#34;&#34;, &#34;password&#34;: &#34;&#34;, &#34;options&#34;: &#34;&#34;, &#34;logs&#34;: &#34;&#34;, &#34;tags&#34;: &#34;&#34;, &#34;jumphost&#34;: &#34;&#34;}}
}
legacy_file = config_dir / &#34;config.json&#34;
legacy_file.write_text(json.dumps(valid_data))
with patch(&#34;os.path.expanduser&#34;, return_value=str(tmp_path)):
from connpy.configfile import configfile
conf = configfile(key=str(key_file))
# Migration should have succeeded: YAML exists, JSON backed up
yaml_file = config_dir / &#34;config.yaml&#34;
assert yaml_file.exists()
assert (config_dir / &#34;config.json.backup&#34;).exists()
assert not legacy_file.exists()
assert &#34;r1&#34; in conf.connections</code></pre>
</details>
<div class="desc"></div>
<h3>Methods</h3>
<dl>
<dt id="connpy.tests.test_configfile.TestMigrationSafety.test_migration_validates_legacy_data"><code class="name flex">
<span>def <span class="ident">test_migration_validates_legacy_data</span></span>(<span>self, tmp_path)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_migration_validates_legacy_data(self, tmp_path):
&#34;&#34;&#34;Migration skips invalid legacy JSON files.&#34;&#34;&#34;
from unittest.mock import patch
config_dir = tmp_path / &#34;.config&#34; / &#34;conn&#34;
config_dir.mkdir(parents=True)
(config_dir / &#34;plugins&#34;).mkdir()
# Write .folder
(config_dir / &#34;.folder&#34;).write_text(str(config_dir))
# Generate RSA key
from Crypto.PublicKey import RSA
key = RSA.generate(2048)
key_file = config_dir / &#34;.osk&#34;
key_file.write_bytes(key.export_key(&#34;PEM&#34;))
os.chmod(str(key_file), 0o600)
# Write invalid JSON config (missing required keys)
legacy_file = config_dir / &#34;config.json&#34;
legacy_file.write_text(json.dumps({&#34;garbage&#34;: True}))
with patch(&#34;os.path.expanduser&#34;, return_value=str(tmp_path)):
from connpy.configfile import configfile
conf = configfile(key=str(key_file))
# Legacy file should NOT have been moved to .backup
assert legacy_file.exists()
assert not (config_dir / &#34;config.json.backup&#34;).exists()</code></pre>
</details>
<div class="desc"><p>Migration skips invalid legacy JSON files.</p></div>
</dd>
<dt id="connpy.tests.test_configfile.TestMigrationSafety.test_migration_verifies_written_yaml"><code class="name flex">
<span>def <span class="ident">test_migration_verifies_written_yaml</span></span>(<span>self, tmp_path)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_migration_verifies_written_yaml(self, tmp_path):
&#34;&#34;&#34;Migration succeeds when legacy JSON is valid.&#34;&#34;&#34;
from unittest.mock import patch
config_dir = tmp_path / &#34;.config&#34; / &#34;conn&#34;
config_dir.mkdir(parents=True)
(config_dir / &#34;plugins&#34;).mkdir()
# Write .folder
(config_dir / &#34;.folder&#34;).write_text(str(config_dir))
# Generate RSA key
from Crypto.PublicKey import RSA
key = RSA.generate(2048)
key_file = config_dir / &#34;.osk&#34;
key_file.write_bytes(key.export_key(&#34;PEM&#34;))
os.chmod(str(key_file), 0o600)
valid_data = {
&#34;config&#34;: {&#34;case&#34;: False, &#34;idletime&#34;: 30, &#34;fzf&#34;: False},
&#34;connections&#34;: {&#34;r1&#34;: {&#34;host&#34;: &#34;1.2.3.4&#34;, &#34;type&#34;: &#34;connection&#34;, &#34;protocol&#34;: &#34;ssh&#34;, &#34;port&#34;: &#34;&#34;, &#34;user&#34;: &#34;&#34;, &#34;password&#34;: &#34;&#34;, &#34;options&#34;: &#34;&#34;, &#34;logs&#34;: &#34;&#34;, &#34;tags&#34;: &#34;&#34;, &#34;jumphost&#34;: &#34;&#34;}},
&#34;profiles&#34;: {&#34;default&#34;: {&#34;host&#34;: &#34;&#34;, &#34;protocol&#34;: &#34;ssh&#34;, &#34;port&#34;: &#34;&#34;, &#34;user&#34;: &#34;&#34;, &#34;password&#34;: &#34;&#34;, &#34;options&#34;: &#34;&#34;, &#34;logs&#34;: &#34;&#34;, &#34;tags&#34;: &#34;&#34;, &#34;jumphost&#34;: &#34;&#34;}}
}
legacy_file = config_dir / &#34;config.json&#34;
legacy_file.write_text(json.dumps(valid_data))
with patch(&#34;os.path.expanduser&#34;, return_value=str(tmp_path)):
from connpy.configfile import configfile
conf = configfile(key=str(key_file))
# Migration should have succeeded: YAML exists, JSON backed up
yaml_file = config_dir / &#34;config.yaml&#34;
assert yaml_file.exists()
assert (config_dir / &#34;config.json.backup&#34;).exists()
assert not legacy_file.exists()
assert &#34;r1&#34; in conf.connections</code></pre>
</details>
<div class="desc"><p>Migration succeeds when legacy JSON is valid.</p></div>
</dd>
</dl>
</dd>
<dt id="connpy.tests.test_configfile.TestValidateConfig"><code class="flex name class">
<span>class <span class="ident">TestValidateConfig</span></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class TestValidateConfig:
def test_valid_config(self, config):
data = {&#34;config&#34;: {}, &#34;connections&#34;: {}, &#34;profiles&#34;: {}}
assert config._validate_config(data) == True
def test_none_data(self, config):
assert config._validate_config(None) == False
def test_string_data(self, config):
assert config._validate_config(&#34;not a dict&#34;) == False
def test_missing_key(self, config):
assert config._validate_config({&#34;config&#34;: {}, &#34;connections&#34;: {}}) == False
def test_empty_dict(self, config):
assert config._validate_config({}) == False</code></pre>
</details>
<div class="desc"></div>
<h3>Methods</h3>
<dl>
<dt id="connpy.tests.test_configfile.TestValidateConfig.test_empty_dict"><code class="name flex">
<span>def <span class="ident">test_empty_dict</span></span>(<span>self, config)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_empty_dict(self, config):
assert config._validate_config({}) == False</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="connpy.tests.test_configfile.TestValidateConfig.test_missing_key"><code class="name flex">
<span>def <span class="ident">test_missing_key</span></span>(<span>self, config)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_missing_key(self, config):
assert config._validate_config({&#34;config&#34;: {}, &#34;connections&#34;: {}}) == False</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="connpy.tests.test_configfile.TestValidateConfig.test_none_data"><code class="name flex">
<span>def <span class="ident">test_none_data</span></span>(<span>self, config)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_none_data(self, config):
assert config._validate_config(None) == False</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="connpy.tests.test_configfile.TestValidateConfig.test_string_data"><code class="name flex">
<span>def <span class="ident">test_string_data</span></span>(<span>self, config)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_string_data(self, config):
assert config._validate_config(&#34;not a dict&#34;) == False</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="connpy.tests.test_configfile.TestValidateConfig.test_valid_config"><code class="name flex">
<span>def <span class="ident">test_valid_config</span></span>(<span>self, config)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def test_valid_config(self, config):
data = {&#34;config&#34;: {}, &#34;connections&#34;: {}, &#34;profiles&#34;: {}}
assert config._validate_config(data) == True</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
@@ -1313,6 +1887,13 @@ el.replaceWith(d);
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="connpy.tests.test_configfile.TestAtomicSave" href="#connpy.tests.test_configfile.TestAtomicSave">TestAtomicSave</a></code></h4>
<ul class="">
<li><code><a title="connpy.tests.test_configfile.TestAtomicSave.test_save_creates_no_leftover_tmp" href="#connpy.tests.test_configfile.TestAtomicSave.test_save_creates_no_leftover_tmp">test_save_creates_no_leftover_tmp</a></code></li>
<li><code><a title="connpy.tests.test_configfile.TestAtomicSave.test_save_preserves_original_on_error" href="#connpy.tests.test_configfile.TestAtomicSave.test_save_preserves_original_on_error">test_save_preserves_original_on_error</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="connpy.tests.test_configfile.TestCRUDNodes" href="#connpy.tests.test_configfile.TestCRUDNodes">TestCRUDNodes</a></code></h4>
<ul class="">
<li><code><a title="connpy.tests.test_configfile.TestCRUDNodes.test_add_folder" href="#connpy.tests.test_configfile.TestCRUDNodes.test_add_folder">test_add_folder</a></code></li>
@@ -1345,6 +1926,14 @@ el.replaceWith(d);
</ul>
</li>
<li>
<h4><code><a title="connpy.tests.test_configfile.TestCorruptionRecovery" href="#connpy.tests.test_configfile.TestCorruptionRecovery">TestCorruptionRecovery</a></code></h4>
<ul class="">
<li><code><a title="connpy.tests.test_configfile.TestCorruptionRecovery.test_both_corrupt_creates_default" href="#connpy.tests.test_configfile.TestCorruptionRecovery.test_both_corrupt_creates_default">test_both_corrupt_creates_default</a></code></li>
<li><code><a title="connpy.tests.test_configfile.TestCorruptionRecovery.test_corrupt_cache_uses_yaml" href="#connpy.tests.test_configfile.TestCorruptionRecovery.test_corrupt_cache_uses_yaml">test_corrupt_cache_uses_yaml</a></code></li>
<li><code><a title="connpy.tests.test_configfile.TestCorruptionRecovery.test_corrupt_yaml_recovers_from_cache" href="#connpy.tests.test_configfile.TestCorruptionRecovery.test_corrupt_yaml_recovers_from_cache">test_corrupt_yaml_recovers_from_cache</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="connpy.tests.test_configfile.TestEncryption" href="#connpy.tests.test_configfile.TestEncryption">TestEncryption</a></code></h4>
<ul class="">
<li><code><a title="connpy.tests.test_configfile.TestEncryption.test_encrypt_decrypt_roundtrip" href="#connpy.tests.test_configfile.TestEncryption.test_encrypt_decrypt_roundtrip">test_encrypt_decrypt_roundtrip</a></code></li>
@@ -1391,6 +1980,23 @@ el.replaceWith(d);
<li><code><a title="connpy.tests.test_configfile.TestGetItem.test_getitems_multiple" href="#connpy.tests.test_configfile.TestGetItem.test_getitems_multiple">test_getitems_multiple</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="connpy.tests.test_configfile.TestMigrationSafety" href="#connpy.tests.test_configfile.TestMigrationSafety">TestMigrationSafety</a></code></h4>
<ul class="">
<li><code><a title="connpy.tests.test_configfile.TestMigrationSafety.test_migration_validates_legacy_data" href="#connpy.tests.test_configfile.TestMigrationSafety.test_migration_validates_legacy_data">test_migration_validates_legacy_data</a></code></li>
<li><code><a title="connpy.tests.test_configfile.TestMigrationSafety.test_migration_verifies_written_yaml" href="#connpy.tests.test_configfile.TestMigrationSafety.test_migration_verifies_written_yaml">test_migration_verifies_written_yaml</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="connpy.tests.test_configfile.TestValidateConfig" href="#connpy.tests.test_configfile.TestValidateConfig">TestValidateConfig</a></code></h4>
<ul class="">
<li><code><a title="connpy.tests.test_configfile.TestValidateConfig.test_empty_dict" href="#connpy.tests.test_configfile.TestValidateConfig.test_empty_dict">test_empty_dict</a></code></li>
<li><code><a title="connpy.tests.test_configfile.TestValidateConfig.test_missing_key" href="#connpy.tests.test_configfile.TestValidateConfig.test_missing_key">test_missing_key</a></code></li>
<li><code><a title="connpy.tests.test_configfile.TestValidateConfig.test_none_data" href="#connpy.tests.test_configfile.TestValidateConfig.test_none_data">test_none_data</a></code></li>
<li><code><a title="connpy.tests.test_configfile.TestValidateConfig.test_string_data" href="#connpy.tests.test_configfile.TestValidateConfig.test_string_data">test_string_data</a></code></li>
<li><code><a title="connpy.tests.test_configfile.TestValidateConfig.test_valid_config" href="#connpy.tests.test_configfile.TestValidateConfig.test_valid_config">test_valid_config</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>