Added the list command. by devanshsonii · Pull Request #359 · The-DevOps-Daily/devops-daily

devanshsonii · 2025-10-01T13:40:15Z

What type of PR is this? (check all applicable)

Description

Added the list command with some dummy commands like cd, pwd etc.
Also fixed the invoke without command on dummy command hello

Related Tickets & Documents

Resolves #329

Added to documentation?

📜 readme
🙅 no documentation needed

[optional] What gif best describes this PR or how it makes you feel?

bobbyiliev

Thanks! The CI seems to be failing.

Also, maybe we should dynamically get the list of available commands from the ebook chapters?

Copilot

Pull Request Overview

Adds a new list subcommand to display sample Linux commands and modifies the hello command behavior to run without specifying the greet subcommand. Updates tests to cover the new list command but does not adjust existing hello tests to reflect the decorator change.

Added list Typer app with a callback that prints a static list of commands
Changed hello command from a subcommand (@app.command) to a callback (@app.callback) but left tests invoking the old subcommand form
Added a test for the list command output

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File	Description
cli/commands/list.py	New list command callback printing command descriptions.
cli/commands/hello.py	Converted greet command into a callback invoked without a subcommand.
cli/cli.py	Registered new list subcommand; imported list module.
cli/test_cli.py	Added test for list command; kept previous hello tests unchanged.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-01T14:16:50Z

cli/commands/hello.py



-@app.command()
+@app.callback(invoke_without_command=True)


Changing greet from a command to a callback removes the hello greet subcommand, but tests still invoke hello greet; this will cause those tests (and existing CLI usage) to fail. Either revert to @app.command() (and possibly add a separate callback if needed) or update tests and documentation to invoke hello (without greet) and use --name when desired.

Suggested change

@app.callback(invoke_without_command=True)

@app.command()

Copilot · 2025-10-01T14:16:50Z

cli/test_cli.py

+    assert "ls - List directory contents" in result.stdout
+    assert "cd - Change directory" in result.stdout
+    assert "pwd - Print working directory" in result.stdout
+    assert "cat - Concatenate and display files" in result.stdout


These assertions expect strings without trailing periods, but list.py currently outputs periods for ls, cd, and pwd; the test will fail. Align either the test expectations (add periods) or the list.py literals (remove periods) consistently across all entries.

Suggested change

assert "ls - List directory contents" in result.stdout

assert "cd - Change directory" in result.stdout

assert "pwd - Print working directory" in result.stdout

assert "cat - Concatenate and display files" in result.stdout

assert "ls - List directory contents." in result.stdout

assert "cd - Change directory." in result.stdout

assert "pwd - Print working directory." in result.stdout

assert "cat - Concatenate and display files." in result.stdout

Copilot · 2025-10-01T14:16:51Z

cli/commands/list.py

+        "ls - List directory contents.",
+        "cd - Change directory.",
+        "pwd - Print working directory.",


Inconsistent punctuation: first three entries end with a period while the last does not, and this inconsistency conflicts with test expectations (which omit periods). Standardize all entries (either all with periods or all without) and sync the tests accordingly.

Suggested change

"ls - List directory contents.",

"cd - Change directory.",

"pwd - Print working directory.",

"ls - List directory contents",

"cd - Change directory",

"pwd - Print working directory",

devanshsonii · 2025-10-01T14:55:06Z

Right, so the issue description specified that

For now, return a static list of a few example commands

I could raise another issue regarding the dynamic list of commands from the chapters and resolve that?
For now I have implemented the changes suggested by copilot.

Copilot

Pull Request Overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-01T19:21:22Z

cli/commands/list.py

+
+app = typer.Typer(help="List the commands available on Linux.")
+
+@app.command()


The test invokes cli.py list expecting the command descriptions to print, but this code defines a Typer sub-app with a subcommand also named list; executing cli.py list (without the subcommand) will show the group help, not run the function. To make cli.py list produce the desired output, either move the logic to a top-level command (remove the nested Typer and register the function directly) or change this to @app.callback() so it runs when no subcommand is provided.

Suggested change

@app.command()

@app.callback()

Copilot · 2025-10-01T19:21:22Z

cli/cli.py

+from commands import list

 # Create the root CLI app
 app = typer.Typer(help="101 Linux Commands CLI 🚀")

 # Register subcommands
 app.add_typer(hello.app, name="hello")
+app.add_typer(list.app, name="list")


Importing a module named list masks the built-in list type in this scope, reducing clarity; renaming the module (e.g., commands_list) or importing with an alias (from commands import list as list_commands) would avoid overshadowing and make intent clearer. Update the registration accordingly (app.add_typer(list_commands.app, name="list")).

Suggested change

from commands import list

# Create the root CLI app

app = typer.Typer(help="101 Linux Commands CLI 🚀")

# Register subcommands

app.add_typer(hello.app, name="hello")

app.add_typer(list.app, name="list")

from commands import list as list_commands

# Create the root CLI app

app = typer.Typer(help="101 Linux Commands CLI 🚀")

# Register subcommands

app.add_typer(hello.app, name="hello")

app.add_typer(list_commands.app, name="list")

Copilot · 2025-10-01T19:21:22Z

cli/cli.py

+from commands import list

 # Create the root CLI app
 app = typer.Typer(help="101 Linux Commands CLI 🚀")

 # Register subcommands
 app.add_typer(hello.app, name="hello")
+app.add_typer(list.app, name="list")


Importing a module named list masks the built-in list type in this scope, reducing clarity; renaming the module (e.g., commands_list) or importing with an alias (from commands import list as list_commands) would avoid overshadowing and make intent clearer. Update the registration accordingly (app.add_typer(list_commands.app, name="list")).

Suggested change

from commands import list

# Create the root CLI app

app = typer.Typer(help="101 Linux Commands CLI 🚀")

# Register subcommands

app.add_typer(hello.app, name="hello")

app.add_typer(list.app, name="list")

from commands import list as list_commands

# Create the root CLI app

app = typer.Typer(help="101 Linux Commands CLI 🚀")

# Register subcommands

app.add_typer(hello.app, name="hello")

app.add_typer(list_commands.app, name="list")

bobbyiliev · 2025-10-01T19:21:31Z

You are right @devanshsonii let's keep the static list for the scope here. If we get the lint to pas we can get this merged right away!

devanshsonii · 2025-10-01T19:23:03Z

Right, I'll get on it.

devanshsonii · 2025-10-01T19:31:21Z

@bobbyiliev should work now.

bobbyiliev · 2025-10-01T19:44:19Z

Thanks @devanshsonii the lint CI is passing, the test CI is failing though. If we get that one to pass we can merge it!

devanshsonii · 2025-10-01T19:49:01Z

@bobbyiliev Confirmed that all test cases are passing.

* Added the list command. * copilot suggested fixes. * lint * all tests passing * Update test_cli.py * Add assertion for command help output in tests * Update cli.py --------- Co-authored-by: Bobby Iliev <bobby@bobbyiliev.com>

Added the list command.

d45b8de

bobbyiliev requested changes Oct 1, 2025

View reviewed changes

bobbyiliev requested a review from Copilot October 1, 2025 14:15

Copilot AI reviewed Oct 1, 2025

View reviewed changes

copilot suggested fixes.

7602b5e

bobbyiliev requested a review from Copilot October 1, 2025 19:20

Copilot AI reviewed Oct 1, 2025

View reviewed changes

lint

03988e8

all tests passing

cae3844

bobbyiliev added 4 commits October 2, 2025 11:34

Merge branch 'main' into list-command

ccaac15

Update test_cli.py

05a9ba8

Add assertion for command help output in tests

215404c

Update cli.py

df20212

bobbyiliev merged commit 9261480 into The-DevOps-Daily:main Oct 2, 2025
2 checks passed

devanshsonii deleted the list-command branch October 2, 2025 08:42


		app = typer.Typer(help="List the commands available on Linux.")

		@app.command()

Conversation

devanshsonii commented Oct 1, 2025

What type of PR is this? (check all applicable)

Description

Related Tickets & Documents

Added to documentation?

[optional] What gif best describes this PR or how it makes you feel?

Uh oh!

bobbyiliev left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

devanshsonii commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

bobbyiliev commented Oct 1, 2025

Uh oh!

devanshsonii commented Oct 1, 2025

Uh oh!

devanshsonii commented Oct 1, 2025

Uh oh!

bobbyiliev commented Oct 1, 2025

Uh oh!

devanshsonii commented Oct 1, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

devanshsonii commented Oct 1, 2025 •

edited

Loading