Page MenuHomeSoftware Heritage
Differential D1799

Docs: Update documentation to improve/clarify steps
ClosedPublic
Actions

Authored by ardumont on Aug 1 2019, 12:15 PM.

Details

Reviewers
ftigeot
Group Reviewers
Reviewers
Commits
rSPRE07128ae2706f: init-template: Clarify the first template connection
rSPRE43f6e2cf0071: init-template.sh: Allow ip customization
rSPRE4121f2d4de4a: Docs: Clarify sentences
Summary

Related T1875

Diff Detail

Repository
rSPRE sysadm-provisioning
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Revision Contents
Changeset List

PathSize
proxmox/
terraform/
22 lines
2 lines

Diff 6068

View Options

proxmox/terraform/README.md

# Copyright (C) 2015 The Software Heritage developers # Copyright (C) 2015 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution # See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version # License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information # See top-level LICENSE file for more information
import unittest
from swh.storage import converters from swh.storage import converters
class TestConverters(unittest.TestCase): def test_date_to_db():
def setUp(self):
self.maxDiff = None
def test_date_to_db(self):
date_to_db = converters.date_to_db date_to_db = converters.date_to_db
assert date_to_db(None) == { assert date_to_db(None) == {
"timestamp": None, "offset": 0, "neg_utc_offset": None} "timestamp": None, "offset": 0, "neg_utc_offset": None}
assert date_to_db({ assert date_to_db({
"timestamp": 1234567890, "timestamp": 1234567890,
"offset": 120, "offset": 120,
"negative_utc": False, "negative_utc": False,
}) == { }) == {
"timestamp": "2009-02-13T23:31:30+00:00", "timestamp": "2009-02-13T23:31:30+00:00",
"offset": 120, "offset": 120,
"neg_utc_offset": False, "neg_utc_offset": False,
} }
assert date_to_db({ assert date_to_db({
"timestamp": 1123456789, "timestamp": 1123456789,
"offset": 0, "offset": 0,
"negative_utc": True, "negative_utc": True,
}) == { }) == {
"timestamp": "2005-08-07T23:19:49+00:00", "timestamp": "2005-08-07T23:19:49+00:00",
"offset": 0, "offset": 0,
"neg_utc_offset": True, "neg_utc_offset": True,
} }
assert date_to_db({ assert date_to_db({
"timestamp": 1234567890, "timestamp": 1234567890,
"offset": 42, "offset": 42,
"negative_utc": False, "negative_utc": False,
}) == { }) == {
"timestamp": "2009-02-13T23:31:30+00:00", "timestamp": "2009-02-13T23:31:30+00:00",
"offset": 42, "offset": 42,
"neg_utc_offset": False, "neg_utc_offset": False,
} }
assert date_to_db({ assert date_to_db({
"timestamp": 1634366813, "timestamp": 1634366813,
"offset": -120, "offset": -120,
"negative_utc": False, "negative_utc": False,
}) == { }) == {
"timestamp": "2021-10-16T06:46:53+00:00", "timestamp": "2021-10-16T06:46:53+00:00",
"offset": -120, "offset": -120,
"neg_utc_offset": False, "neg_utc_offset": False,
} }
def test_db_to_author(self):
def test_db_to_author():
# when # when
actual_author = converters.db_to_author( actual_author = converters.db_to_author(
b'fullname', b'name', b'email') b'fullname', b'name', b'email')
# then # then
self.assertEqual(actual_author, { assert actual_author == {
'fullname': b'fullname', 'fullname': b'fullname',
'name': b'name', 'name': b'name',
'email': b'email', 'email': b'email',
}) }
def test_db_to_revision(self): def test_db_to_revision():
# when # when
actual_revision = converters.db_to_revision({ actual_revision = converters.db_to_revision({
'id': 'revision-id', 'id': 'revision-id',
'date': None, 'date': None,
'date_offset': None, 'date_offset': None,
'date_neg_utc_offset': None, 'date_neg_utc_offset': None,
'committer_date': None, 'committer_date': None,
'committer_date_offset': None, 'committer_date_offset': None,
'committer_date_neg_utc_offset': None, 'committer_date_neg_utc_offset': None,
'type': 'rev', 'type': 'rev',
'directory': b'dir-sha1', 'directory': b'dir-sha1',
'message': b'commit message', 'message': b'commit message',
'author_fullname': b'auth-fullname', 'author_fullname': b'auth-fullname',
'author_name': b'auth-name', 'author_name': b'auth-name',
'author_email': b'auth-email', 'author_email': b'auth-email',
'committer_fullname': b'comm-fullname', 'committer_fullname': b'comm-fullname',
'committer_name': b'comm-name', 'committer_name': b'comm-name',
'committer_email': b'comm-email', 'committer_email': b'comm-email',
'metadata': {}, 'metadata': {},
'synthetic': False, 'synthetic': False,
'parents': [123, 456] 'parents': [123, 456]
}) })
# then # then
self.assertEqual(actual_revision, { assert actual_revision == {
'id': 'revision-id', 'id': 'revision-id',
'author': { 'author': {
'fullname': b'auth-fullname', 'fullname': b'auth-fullname',
'name': b'auth-name', 'name': b'auth-name',
'email': b'auth-email', 'email': b'auth-email',
}, },
'date': None, 'date': None,
'committer': { 'committer': {
'fullname': b'comm-fullname', 'fullname': b'comm-fullname',
'name': b'comm-name', 'name': b'comm-name',
'email': b'comm-email', 'email': b'comm-email',
}, },
'committer_date': None, 'committer_date': None,
'type': 'rev', 'type': 'rev',
'directory': b'dir-sha1', 'directory': b'dir-sha1',
'message': b'commit message', 'message': b'commit message',
'metadata': {}, 'metadata': {},
'synthetic': False, 'synthetic': False,
'parents': [123, 456], 'parents': [123, 456],
}) }
def test_db_to_release(self): def test_db_to_release():
# when # when
actual_release = converters.db_to_release({ actual_release = converters.db_to_release({
'id': b'release-id', 'id': b'release-id',
'target': b'revision-id', 'target': b'revision-id',
'target_type': 'revision', 'target_type': 'revision',
'date': None, 'date': None,
'date_offset': None, 'date_offset': None,
'date_neg_utc_offset': None, 'date_neg_utc_offset': None,
'name': b'release-name', 'name': b'release-name',
'comment': b'release comment', 'comment': b'release comment',
'synthetic': True, 'synthetic': True,
'author_fullname': b'auth-fullname', 'author_fullname': b'auth-fullname',
'author_name': b'auth-name', 'author_name': b'auth-name',
'author_email': b'auth-email', 'author_email': b'auth-email',
}) })
# then # then
self.assertEqual(actual_release, { assert actual_release == {
'author': { 'author': {
'fullname': b'auth-fullname', 'fullname': b'auth-fullname',
'name': b'auth-name', 'name': b'auth-name',
'email': b'auth-email', 'email': b'auth-email',
}, },
'date': None, 'date': None,
'id': b'release-id', 'id': b'release-id',
'name': b'release-name', 'name': b'release-name',
'message': b'release comment', 'message': b'release comment',
'synthetic': True, 'synthetic': True,
'target': b'revision-id', 'target': b'revision-id',
'target_type': 'revision' 'target_type': 'revision'
}) }
def test_db_to_git_headers(self): def test_db_to_git_headers():
raw_data = [ raw_data = [
['gpgsig', b'garbage\x89a\x43b\x14'], ['gpgsig', b'garbage\x89a\x43b\x14'],
['extra', [b'fo\\\\\\o', b'bar\\', b'inval\\\\\x99id']], ['extra', [b'fo\\\\\\o', b'bar\\', b'inval\\\\\x99id']],
] ]
db_data = converters.git_headers_to_db(raw_data) db_data = converters.git_headers_to_db(raw_data)
loop = converters.db_to_git_headers(db_data) loop = converters.db_to_git_headers(db_data)
self.assertEqual(raw_data, loop) assert raw_data == loop
View Options

proxmox/terraform/prepare-workstation.md

# Copyright (C) 2015 The Software Heritage developers # Copyright (C) 2015 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution # See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version # License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information # See top-level LICENSE file for more information
import unittest
from swh.storage import converters from swh.storage import converters
class TestConverters(unittest.TestCase): def test_date_to_db():
def setUp(self):
self.maxDiff = None
def test_date_to_db(self):
date_to_db = converters.date_to_db date_to_db = converters.date_to_db
assert date_to_db(None) == { assert date_to_db(None) == {
"timestamp": None, "offset": 0, "neg_utc_offset": None} "timestamp": None, "offset": 0, "neg_utc_offset": None}
assert date_to_db({ assert date_to_db({
"timestamp": 1234567890, "timestamp": 1234567890,
"offset": 120, "offset": 120,
"negative_utc": False, "negative_utc": False,
}) == { }) == {
"timestamp": "2009-02-13T23:31:30+00:00", "timestamp": "2009-02-13T23:31:30+00:00",
"offset": 120, "offset": 120,
"neg_utc_offset": False, "neg_utc_offset": False,
} }
assert date_to_db({ assert date_to_db({
"timestamp": 1123456789, "timestamp": 1123456789,
"offset": 0, "offset": 0,
"negative_utc": True, "negative_utc": True,
}) == { }) == {
"timestamp": "2005-08-07T23:19:49+00:00", "timestamp": "2005-08-07T23:19:49+00:00",
"offset": 0, "offset": 0,
"neg_utc_offset": True, "neg_utc_offset": True,
} }
assert date_to_db({ assert date_to_db({
"timestamp": 1234567890, "timestamp": 1234567890,
"offset": 42, "offset": 42,
"negative_utc": False, "negative_utc": False,
}) == { }) == {
"timestamp": "2009-02-13T23:31:30+00:00", "timestamp": "2009-02-13T23:31:30+00:00",
"offset": 42, "offset": 42,
"neg_utc_offset": False, "neg_utc_offset": False,
} }
assert date_to_db({ assert date_to_db({
"timestamp": 1634366813, "timestamp": 1634366813,
"offset": -120, "offset": -120,
"negative_utc": False, "negative_utc": False,
}) == { }) == {
"timestamp": "2021-10-16T06:46:53+00:00", "timestamp": "2021-10-16T06:46:53+00:00",
"offset": -120, "offset": -120,
"neg_utc_offset": False, "neg_utc_offset": False,
} }
def test_db_to_author(self):
def test_db_to_author():
# when # when
actual_author = converters.db_to_author( actual_author = converters.db_to_author(
b'fullname', b'name', b'email') b'fullname', b'name', b'email')
# then # then
self.assertEqual(actual_author, { assert actual_author == {
'fullname': b'fullname', 'fullname': b'fullname',
'name': b'name', 'name': b'name',
'email': b'email', 'email': b'email',
}) }
def test_db_to_revision(self): def test_db_to_revision():
# when # when
actual_revision = converters.db_to_revision({ actual_revision = converters.db_to_revision({
'id': 'revision-id', 'id': 'revision-id',
'date': None, 'date': None,
'date_offset': None, 'date_offset': None,
'date_neg_utc_offset': None, 'date_neg_utc_offset': None,
'committer_date': None, 'committer_date': None,
'committer_date_offset': None, 'committer_date_offset': None,
'committer_date_neg_utc_offset': None, 'committer_date_neg_utc_offset': None,
'type': 'rev', 'type': 'rev',
'directory': b'dir-sha1', 'directory': b'dir-sha1',
'message': b'commit message', 'message': b'commit message',
'author_fullname': b'auth-fullname', 'author_fullname': b'auth-fullname',
'author_name': b'auth-name', 'author_name': b'auth-name',
'author_email': b'auth-email', 'author_email': b'auth-email',
'committer_fullname': b'comm-fullname', 'committer_fullname': b'comm-fullname',
'committer_name': b'comm-name', 'committer_name': b'comm-name',
'committer_email': b'comm-email', 'committer_email': b'comm-email',
'metadata': {}, 'metadata': {},
'synthetic': False, 'synthetic': False,
'parents': [123, 456] 'parents': [123, 456]
}) })
# then # then
self.assertEqual(actual_revision, { assert actual_revision == {
'id': 'revision-id', 'id': 'revision-id',
'author': { 'author': {
'fullname': b'auth-fullname', 'fullname': b'auth-fullname',
'name': b'auth-name', 'name': b'auth-name',
'email': b'auth-email', 'email': b'auth-email',
}, },
'date': None, 'date': None,
'committer': { 'committer': {
'fullname': b'comm-fullname', 'fullname': b'comm-fullname',
'name': b'comm-name', 'name': b'comm-name',
'email': b'comm-email', 'email': b'comm-email',
}, },
'committer_date': None, 'committer_date': None,
'type': 'rev', 'type': 'rev',
'directory': b'dir-sha1', 'directory': b'dir-sha1',
'message': b'commit message', 'message': b'commit message',
'metadata': {}, 'metadata': {},
'synthetic': False, 'synthetic': False,
'parents': [123, 456], 'parents': [123, 456],
}) }
def test_db_to_release(self): def test_db_to_release():
# when # when
actual_release = converters.db_to_release({ actual_release = converters.db_to_release({
'id': b'release-id', 'id': b'release-id',
'target': b'revision-id', 'target': b'revision-id',
'target_type': 'revision', 'target_type': 'revision',
'date': None, 'date': None,
'date_offset': None, 'date_offset': None,
'date_neg_utc_offset': None, 'date_neg_utc_offset': None,
'name': b'release-name', 'name': b'release-name',
'comment': b'release comment', 'comment': b'release comment',
'synthetic': True, 'synthetic': True,
'author_fullname': b'auth-fullname', 'author_fullname': b'auth-fullname',
'author_name': b'auth-name', 'author_name': b'auth-name',
'author_email': b'auth-email', 'author_email': b'auth-email',
}) })
# then # then
self.assertEqual(actual_release, { assert actual_release == {
'author': { 'author': {
'fullname': b'auth-fullname', 'fullname': b'auth-fullname',
'name': b'auth-name', 'name': b'auth-name',
'email': b'auth-email', 'email': b'auth-email',
}, },
'date': None, 'date': None,
'id': b'release-id', 'id': b'release-id',
'name': b'release-name', 'name': b'release-name',
'message': b'release comment', 'message': b'release comment',
'synthetic': True, 'synthetic': True,
'target': b'revision-id', 'target': b'revision-id',
'target_type': 'revision' 'target_type': 'revision'
}) }
def test_db_to_git_headers(self): def test_db_to_git_headers():
raw_data = [ raw_data = [
['gpgsig', b'garbage\x89a\x43b\x14'], ['gpgsig', b'garbage\x89a\x43b\x14'],
['extra', [b'fo\\\\\\o', b'bar\\', b'inval\\\\\x99id']], ['extra', [b'fo\\\\\\o', b'bar\\', b'inval\\\\\x99id']],
] ]
db_data = converters.git_headers_to_db(raw_data) db_data = converters.git_headers_to_db(raw_data)
loop = converters.db_to_git_headers(db_data) loop = converters.db_to_git_headers(db_data)
self.assertEqual(raw_data, loop) assert raw_data == loop
About · Developer information · Legal