Removes pipfile (#88)

* Removes pipfile
* Replace ruamel with pyyaml

Author: Måns Magnusson

.gitignore

@@ -72,6 +72,10 @@ alembic.ini
 *.mod.yaml
 meta.yaml
 
+# Environement stuff
+
+venv
+
 # Local files
 local/
 

CHANGELOG.md

@@ -12,6 +12,13 @@ Please add a new candidate release at the top after changing the latest one. Fee
 ### Changed
 ### Fixed
 
+## [3.2.1]
+
+### Changed
+- Replace ruamel.yaml with pyyaml for consistency in prod environment
+- Deleted unused Pipfile and Pipfile.lock since they trigger dependabots
+
+
 ## [3.2.0]
 
 ### Added

Dockerfile

@@ -10,7 +10,7 @@ LABEL about.license="MIT License (MIT)"
 LABEL about.tags="files,database"
 LABEL maintainer="Måns Magusson <[email protected]>"
 
-RUN pip install -U pip
+RUN pip install --no-cache-dir -U pip
 # Avoid running as root for security reasons
 # More about that: https://pythonspeed.com/articles/root-capabilities-docker-security/
 # Solution inspired from
@@ -19,21 +19,15 @@ RUN useradd --create-home worker
 USER worker
 WORKDIR /home/worker
 
-# Based on https://pythonspeed.com/articles/pipenv-docker/
-RUN pip install --user micropipenv pymysql cryptography
-# Update the path for micropipenv
-ENV PATH="/home/worker/.local/bin:${PATH}"
 
 # Copy the lockfile to temporary directory. This will be deleted
-COPY --chown=worker:worker Pipfile.lock /tmp/
-# Generate reqs with locked dependencies for deterministic build
-RUN cd /tmp && micropipenv requirements > requirements.txt
+COPY --chown=worker:worker requirements.txt /tmp/
 # Install deps
-RUN pip install --user -r /tmp/requirements.txt
+RUN pip install --no-cache-dir --user -r /tmp/requirements.txt
 # Copy package
 COPY --chown=worker:worker . /tmp/housekeeper
 # Install package
-RUN pip install /tmp/housekeeper
+RUN pip install --no-cache-dir /tmp/housekeeper
 
 ENTRYPOINT ["housekeeper"]
 CMD ["--help"]

Pipfile

@@ -1,9 +1,10 @@
 """Module for base CLI"""
 import logging
+from typing import Optional
 
 import click
 import coloredlogs
-import ruamel.yaml
+import yaml
 
 import housekeeper
 from housekeeper.store import Store
@@ -20,12 +21,15 @@
 @click.option("-l", "--log-level", default="INFO")
 @click.version_option(housekeeper.__version__, prog_name=housekeeper.__title__)
 @click.pass_context
-def base(context, config, database, root, log_level):
+def base(context: click.Context, config: click.File, database: Optional[str], root: Optional[str], log_level: str):
     """Housekeeper - Access your files!"""
     coloredlogs.install(level=log_level)
-    context.obj = ruamel.yaml.safe_load(config) if config else {}
-    db_path = database if database else context.obj.get("database")
-    root_path = context.obj["root"] = root if root else context.obj.get("root")
+    config_values = {}
+    if config:
+        config_values = yaml.full_load(config)
+    context.obj = config_values
+    db_path = database or context.obj.get("database")
+    root_path = context.obj["root"] = root or context.obj.get("root")
     if not db_path:
         LOG.error("Please point to a database")
         raise click.Abort

Pipfile.lock

@@ -2,6 +2,6 @@ Alchy
 Click<7
 coloredlogs
 marshmallow
-ruamel.yaml
+pyyaml
 SQLAlchemy
 rich

housekeeper/cli/core.py

@@ -1,4 +1,5 @@
 """Tests for the core cli"""
+import logging
 
 import housekeeper
 from housekeeper.cli.core import base
@@ -79,8 +80,9 @@ def test_init_database_no_specified_root_dir(cli_runner, db_uri):
     assert "Please specify a root dir" in result.output
 
 
-def test_init_existing_database(cli_runner, base_context, db_path):
+def test_init_existing_database(cli_runner, base_context, db_path, caplog):
     """Test to initialise a housekeeper instance when db already exists"""
+    caplog.set_level(logging.INFO)
     # GIVEN the uri to an initialised database, a project dir and a cli runner
     assert db_path.exists()
 
@@ -90,11 +92,12 @@ def test_init_existing_database(cli_runner, base_context, db_path):
     # THEN a controlled exit should be made
     assert result.exit_code == 1
     # THEN it should communicate that the database exists
-    assert "Database already exists" in result.output
+    assert "Database already exists" in caplog.text
 
 
-def test_override_existing_database(cli_runner, db_path, base_context):
+def test_override_existing_database(cli_runner, db_path, base_context, caplog):
     """Test init housekeeper database and overwrite existing one"""
+    caplog.set_level(logging.INFO)
     # GIVEN the uri to an initialised database, a project dir and a cli runner
     assert db_path.exists()
 
@@ -104,16 +107,17 @@ def test_override_existing_database(cli_runner, db_path, base_context):
     # THEN it should communicate that the database exists
     assert "Delete existing tables?" in result.output
     # THEN it should communicate success
-    assert "Success!" in result.output
+    assert "Success!" in caplog.text
 
 
-def test_force_override_existing_database(cli_runner, db_path, base_context):
+def test_force_override_existing_database(cli_runner, db_path, base_context, caplog):
     """Test init housekeeper database and overwrite existing one"""
+    caplog.set_level(logging.INFO)
     # GIVEN the uri to an initialised database, a project dir and a cli runner
     assert db_path.exists()
 
     # WHEN intitializing and overriding existing db
-    result = cli_runner.invoke(init_command, ["--force"], obj=base_context)
+    cli_runner.invoke(init_command, ["--force"], obj=base_context)
 
     # THEN it should communicate success
-    assert "Success!" in result.output
+    assert "Success!" in caplog.text

requirements.txt

@@ -8,7 +8,7 @@
 from typing import List
 
 import pytest
-import ruamel.yaml
+import yaml
 
 from housekeeper.date import get_date
 from housekeeper.store import Store, models
@@ -297,7 +297,7 @@ def fixture_config_file(config_dir: Path, configs: dict) -> Path:
     """Create a config file and return the path to it"""
     conf_path = config_dir / "config.json"
     with open(conf_path, "w") as out_file:
-        out_file.write(ruamel.yaml.safe_dump(configs))
+        yaml.dump(configs, out_file)
     return conf_path