Skip to content

Add temporary directory to verbose output #572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions lean/click.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,21 @@ def get_whoami_message() -> str:

return f"logged in as {member.name} ({member.email})"

def get_disk_space_info(path: Path) -> str:
import shutil
try:
usage = shutil.disk_usage(str(path))
total, used, free = usage.total, usage.used, usage.free

return (
f"Space in temporary location - "
f"Total: {total / (1024 ** 3):.2f} GB, "
f"Used: {used / (1024 ** 3):.2f} GB, "
f"Free: {free / (1024 ** 3):.2f} GB"
)
except Exception as e:
return f"Error getting disk space: {str(e)}"

class VerboseOption(ClickOption):
def __init__(self, *args, **kwargs):
super().__init__(["--verbose"],
Expand Down Expand Up @@ -131,11 +146,21 @@ def _parse_verbose_option(ctx: Context, param: Parameter, value: Optional[bool])
except:
docker_version = "Not installed"

try:
temp_dir = container.temp_manager.create_temporary_directory().parent
space_info = get_disk_space_info(temp_dir)
except:
temp_dir = ""
space_info = ""


logger.debug(f"Context information:\n" +
hostname +
username +
f" Python version: {python_version}\n"
f" OS: {platform()}\n"
f" Temporary directory: {temp_dir}\n"
f" {space_info}\n"
f" Lean CLI version: {lean_cli_version}\n"
f" .NET version: {dotnet_version}\n"
f" VS Code version: {vscode_version}\n"
Expand Down
5 changes: 4 additions & 1 deletion lean/components/util/temp_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,16 @@
# limitations under the License.

from pathlib import Path
from lean.components.util.logger import Logger

class TempManager:
"""The TempManager class provides access to temporary directories."""

def __init__(self) -> None:
def __init__(self, logger: Logger) -> None:
"""Creates a new TempManager instance."""
self._temporary_directories = []
self.delete_temporary_directories_when_done = True
self._logger = logger

def create_temporary_directory(self) -> Path:
"""Returns the path to an empty temporary directory.
Expand All @@ -29,6 +31,7 @@ def create_temporary_directory(self) -> Path:
from tempfile import mkdtemp
path = Path(mkdtemp(prefix="lean-cli-"))
self._temporary_directories.append(path)
self._logger.debug(f"Created temporary directory: {path}")
return path

def delete_temporary_directories(self) -> None:
Expand Down
4 changes: 2 additions & 2 deletions lean/container.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ def initialize(self,
self.platform_manager = PlatformManager()
self.task_manager = TaskManager(self.logger)
self.name_generator = NameGenerator()
self.temp_manager = TempManager()
self.temp_manager = TempManager(self.logger)
self.xml_manager = XMLManager()
self.http_client = HTTPClient(self.logger)

Expand Down Expand Up @@ -211,4 +211,4 @@ def manage_docker_image(self, image: Optional[str], update: bool, no_update: boo
return engine_image, container_module_version, project_config


container = Container()
container = Container()
2 changes: 1 addition & 1 deletion tests/components/docker/test_lean_runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ def create_lean_runner(docker_manager: mock.Mock) -> LeanRunner:
docker_manager,
module_manager,
project_manager,
TempManager(),
TempManager(logger),
xml_manager)


Expand Down
8 changes: 4 additions & 4 deletions tests/components/util/test_temp_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from lean.components.util.temp_manager import TempManager
from unittest import mock


def test_create_temporary_directory_creates_empty_directory() -> None:
temp_manager = TempManager()
temp_manager = TempManager(mock.Mock())

path = temp_manager.create_temporary_directory()

Expand All @@ -24,13 +24,13 @@ def test_create_temporary_directory_creates_empty_directory() -> None:


def test_create_temporary_directory_creates_new_directory_every_time() -> None:
temp_manager = TempManager()
temp_manager = TempManager(mock.Mock())

assert temp_manager.create_temporary_directory() != temp_manager.create_temporary_directory()


def test_delete_temporary_directories_deletes_all_previously_created_directories() -> None:
temp_manager = TempManager()
temp_manager = TempManager(mock.Mock())

paths = []
for i in range(5):
Expand Down
Loading