mirror of
https://github.com/freedomofpress/dangerzone.git
synced 2025-05-07 05:51:50 +02:00
Compare commits
1 commit
cc4d0cd03d
...
e055fed1bf
Author | SHA1 | Date | |
---|---|---|---|
e055fed1bf |
6 changed files with 19 additions and 52 deletions
18
.github/workflows/check_pr.yml
vendored
18
.github/workflows/check_pr.yml
vendored
|
@ -1,7 +1,6 @@
|
||||||
name: Check branch conformity
|
name: Check branch conformity
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
types: ["opened", "labeled", "unlabeled", "reopened", "synchronize"]
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
prevent-fixup-commits:
|
prevent-fixup-commits:
|
||||||
|
@ -21,10 +20,17 @@ jobs:
|
||||||
|
|
||||||
check-changelog:
|
check-changelog:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
name: Ensure CHANGELOG.md is populated for user-visible changes
|
|
||||||
steps:
|
steps:
|
||||||
# Pin the GitHub action to a specific commit that we have audited and know
|
- name: Checkout code
|
||||||
# how it works.
|
uses: actions/checkout@v4
|
||||||
- uses: tarides/changelog-check-action@509965da3b8ac786a5e2da30c2ccf9661189121f
|
|
||||||
with:
|
with:
|
||||||
changelog: CHANGELOG.md
|
fetch-depth: 0
|
||||||
|
- name: ensure CHANGELOG.md is populated
|
||||||
|
env:
|
||||||
|
BASE_REF: ${{ github.event.pull_request.base.ref }}
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
if git diff --exit-code "origin/${BASE_REF}" -- CHANGELOG.md; then
|
||||||
|
echo "::error::No CHANGELOG.md modifications were found in this pull request."
|
||||||
|
return -1;
|
||||||
|
fi
|
||||||
|
|
|
@ -17,7 +17,6 @@ Here is a list of tasks that should be done before issuing the release:
|
||||||
- [ ] Bump the Debian version by adding a new changelog entry in `debian/changelog`
|
- [ ] Bump the Debian version by adding a new changelog entry in `debian/changelog`
|
||||||
- [ ] [Bump the minimum Docker Desktop versions](https://github.com/freedomofpress/dangerzone/blob/main/RELEASE.md#bump-the-minimum-docker-desktop-version) in `isolation_provider/container.py`
|
- [ ] [Bump the minimum Docker Desktop versions](https://github.com/freedomofpress/dangerzone/blob/main/RELEASE.md#bump-the-minimum-docker-desktop-version) in `isolation_provider/container.py`
|
||||||
- [ ] Bump the dates and versions in the `Dockerfile`
|
- [ ] Bump the dates and versions in the `Dockerfile`
|
||||||
- [ ] Update the download links in our `INSTALL.md` page to point to the new version (the download links will be populated after the release)
|
|
||||||
- [ ] Update screenshot in `README.md`, if necessary
|
- [ ] Update screenshot in `README.md`, if necessary
|
||||||
- [ ] CHANGELOG.md should be updated to include a list of all major changes since the last release
|
- [ ] CHANGELOG.md should be updated to include a list of all major changes since the last release
|
||||||
- [ ] A draft release should be created. Copy the release notes text from the template at [`docs/templates/release-notes`](https://github.com/freedomofpress/dangerzone/tree/main/docs/templates/)
|
- [ ] A draft release should be created. Copy the release notes text from the template at [`docs/templates/release-notes`](https://github.com/freedomofpress/dangerzone/tree/main/docs/templates/)
|
||||||
|
@ -341,7 +340,7 @@ To publish the release, you can follow these steps:
|
||||||
|
|
||||||
- [ ] Update the [Dangerzone website](https://github.com/freedomofpress/dangerzone.rocks) to link to the new installers.
|
- [ ] Update the [Dangerzone website](https://github.com/freedomofpress/dangerzone.rocks) to link to the new installers.
|
||||||
- [ ] Update the brew cask release of Dangerzone with a [PR like this one](https://github.com/Homebrew/homebrew-cask/pull/116319)
|
- [ ] Update the brew cask release of Dangerzone with a [PR like this one](https://github.com/Homebrew/homebrew-cask/pull/116319)
|
||||||
- [ ] Update version and links to our installation instructions (`INSTALL.md`) in `README.md`
|
- [ ] Update version and download links in `README.md`
|
||||||
|
|
||||||
## Post-release
|
## Post-release
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,6 @@ from .isolation_provider.container import Container
|
||||||
from .isolation_provider.dummy import Dummy
|
from .isolation_provider.dummy import Dummy
|
||||||
from .isolation_provider.qubes import Qubes, is_qubes_native_conversion
|
from .isolation_provider.qubes import Qubes, is_qubes_native_conversion
|
||||||
from .logic import DangerzoneCore
|
from .logic import DangerzoneCore
|
||||||
from .settings import Settings
|
|
||||||
from .util import get_version, replace_control_chars
|
from .util import get_version, replace_control_chars
|
||||||
|
|
||||||
|
|
||||||
|
@ -49,11 +48,6 @@ def print_header(s: str) -> None:
|
||||||
flag_value=True,
|
flag_value=True,
|
||||||
help="Run Dangerzone in debug mode, to get logs from gVisor.",
|
help="Run Dangerzone in debug mode, to get logs from gVisor.",
|
||||||
)
|
)
|
||||||
@click.option(
|
|
||||||
"--set-container-runtime",
|
|
||||||
required=False,
|
|
||||||
help="The path to the container runtime you want to set in the settings",
|
|
||||||
)
|
|
||||||
@click.version_option(version=get_version(), message="%(version)s")
|
@click.version_option(version=get_version(), message="%(version)s")
|
||||||
@errors.handle_document_errors
|
@errors.handle_document_errors
|
||||||
def cli_main(
|
def cli_main(
|
||||||
|
@ -63,14 +57,8 @@ def cli_main(
|
||||||
archive: bool,
|
archive: bool,
|
||||||
dummy_conversion: bool,
|
dummy_conversion: bool,
|
||||||
debug: bool,
|
debug: bool,
|
||||||
set_container_runtime: Optional[str] = None,
|
|
||||||
) -> None:
|
) -> None:
|
||||||
setup_logging()
|
setup_logging()
|
||||||
display_banner()
|
|
||||||
if set_container_runtime:
|
|
||||||
settings = Settings()
|
|
||||||
settings.set("container_runtime", set_container_runtime, autosave=True)
|
|
||||||
click.echo(f"Set the settings container_runtime to {set_container_runtime}")
|
|
||||||
|
|
||||||
if getattr(sys, "dangerzone_dev", False) and dummy_conversion:
|
if getattr(sys, "dangerzone_dev", False) and dummy_conversion:
|
||||||
dangerzone = DangerzoneCore(Dummy())
|
dangerzone = DangerzoneCore(Dummy())
|
||||||
|
@ -79,6 +67,7 @@ def cli_main(
|
||||||
else:
|
else:
|
||||||
dangerzone = DangerzoneCore(Container(debug=debug))
|
dangerzone = DangerzoneCore(Container(debug=debug))
|
||||||
|
|
||||||
|
display_banner()
|
||||||
if len(filenames) == 1 and output_filename:
|
if len(filenames) == 1 and output_filename:
|
||||||
dangerzone.add_document_from_filename(filenames[0], output_filename, archive)
|
dangerzone.add_document_from_filename(filenames[0], output_filename, archive)
|
||||||
elif len(filenames) > 1 and output_filename:
|
elif len(filenames) > 1 and output_filename:
|
||||||
|
@ -331,10 +320,4 @@ def display_banner() -> None:
|
||||||
+ Style.DIM
|
+ Style.DIM
|
||||||
+ "│"
|
+ "│"
|
||||||
)
|
)
|
||||||
print(
|
print(Back.BLACK + Fore.YELLOW + Style.DIM + "╰──────────────────────────╯")
|
||||||
Back.BLACK
|
|
||||||
+ Fore.YELLOW
|
|
||||||
+ Style.DIM
|
|
||||||
+ "╰──────────────────────────╯"
|
|
||||||
+ Style.RESET_ALL
|
|
||||||
)
|
|
||||||
|
|
|
@ -21,8 +21,6 @@ class Runtime(object):
|
||||||
|
|
||||||
if settings.custom_runtime_specified():
|
if settings.custom_runtime_specified():
|
||||||
self.path = Path(settings.get("container_runtime"))
|
self.path = Path(settings.get("container_runtime"))
|
||||||
if not self.path.exists():
|
|
||||||
raise errors.UnsupportedContainerRuntime(self.path)
|
|
||||||
self.name = self.path.stem
|
self.name = self.path.stem
|
||||||
else:
|
else:
|
||||||
self.name = self.get_default_runtime_name()
|
self.name = self.get_default_runtime_name()
|
||||||
|
@ -31,9 +29,6 @@ class Runtime(object):
|
||||||
raise errors.NoContainerTechException(self.name)
|
raise errors.NoContainerTechException(self.name)
|
||||||
self.path = Path(binary_path)
|
self.path = Path(binary_path)
|
||||||
|
|
||||||
if self.name not in ("podman", "docker"):
|
|
||||||
raise errors.UnsupportedContainerRuntime(self.name)
|
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def get_default_runtime_name() -> str:
|
def get_default_runtime_name() -> str:
|
||||||
return "podman" if platform.system() == "Linux" else "docker"
|
return "podman" if platform.system() == "Linux" else "docker"
|
||||||
|
|
|
@ -140,7 +140,3 @@ class NotAvailableContainerTechException(Exception):
|
||||||
self.error = error
|
self.error = error
|
||||||
self.container_tech = container_tech
|
self.container_tech = container_tech
|
||||||
super().__init__(f"{container_tech} is not available")
|
super().__init__(f"{container_tech} is not available")
|
||||||
|
|
||||||
|
|
||||||
class UnsupportedContainerRuntime(Exception):
|
|
||||||
pass
|
|
||||||
|
|
|
@ -1,21 +1,20 @@
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import pytest
|
|
||||||
from pytest_mock import MockerFixture
|
from pytest_mock import MockerFixture
|
||||||
|
|
||||||
from dangerzone import errors
|
|
||||||
from dangerzone.container_utils import Runtime
|
from dangerzone.container_utils import Runtime
|
||||||
from dangerzone.settings import Settings
|
from dangerzone.settings import Settings
|
||||||
|
|
||||||
|
|
||||||
def test_get_runtime_name_from_settings(mocker: MockerFixture, tmp_path: Path) -> None:
|
def test_get_runtime_name_from_settings(mocker: MockerFixture, tmp_path: Path) -> None:
|
||||||
mocker.patch("dangerzone.settings.get_config_dir", return_value=tmp_path)
|
mocker.patch("dangerzone.settings.get_config_dir", return_value=tmp_path)
|
||||||
mocker.patch("dangerzone.container_utils.Path.exists", return_value=True)
|
|
||||||
|
|
||||||
settings = Settings()
|
settings = Settings()
|
||||||
settings.set("container_runtime", "/opt/somewhere/docker", autosave=True)
|
settings.set(
|
||||||
|
"container_runtime", "/opt/somewhere/new-kid-on-the-block", autosave=True
|
||||||
|
)
|
||||||
|
|
||||||
assert Runtime().name == "docker"
|
assert Runtime().name == "new-kid-on-the-block"
|
||||||
|
|
||||||
|
|
||||||
def test_get_runtime_name_linux(mocker: MockerFixture, tmp_path: Path) -> None:
|
def test_get_runtime_name_linux(mocker: MockerFixture, tmp_path: Path) -> None:
|
||||||
|
@ -47,14 +46,3 @@ def test_get_runtime_name_non_linux(mocker: MockerFixture, tmp_path: Path) -> No
|
||||||
assert runtime.name == "docker"
|
assert runtime.name == "docker"
|
||||||
assert runtime.path == Path("/usr/bin/docker")
|
assert runtime.path == Path("/usr/bin/docker")
|
||||||
assert Runtime().name == "docker"
|
assert Runtime().name == "docker"
|
||||||
|
|
||||||
|
|
||||||
def test_get_unsupported_runtime_name(mocker: MockerFixture, tmp_path: Path) -> None:
|
|
||||||
mocker.patch("dangerzone.settings.get_config_dir", return_value=tmp_path)
|
|
||||||
settings = Settings()
|
|
||||||
settings.set(
|
|
||||||
"container_runtime", "/opt/somewhere/new-kid-on-the-block", autosave=True
|
|
||||||
)
|
|
||||||
|
|
||||||
with pytest.raises(errors.UnsupportedContainerRuntime):
|
|
||||||
assert Runtime().name == "new-kid-on-the-block"
|
|
||||||
|
|
Loading…
Reference in a new issue