extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-08-16 14:41:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

remove stdlib logging env variables (#12196)

Browse Source 
# Description

This PR removes the environment variables associated with stdlib
logging. We need not pollute the environment since it contains a finite
amount of space. This PR changes the env vars to exported custom
commands.
 
# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->

# Tests + Formatting
<!--
Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to
check that you're using the standard code style
- `cargo test --workspace` to check that all tests pass (on Windows make
sure to [enable developer
mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging))
- `cargo run -- -c "use std testing; testing run-tests --path
crates/nu-std"` to run the tests for the standard library

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```
-->

# After Submitting
<!-- If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
-->
This commit is contained in:
Darren Schroeder
2024-03-14 06:28:13 -05:00
committed by GitHub
parent 3c4ae7b1a6
commit 8abc7e6d5e
5 changed files with 107 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
crates/nu-std/tests/logger_tests/test_basic_commands.nu
View File

@ -7,9 +7,9 @@ def run [
] {
do {
if $short {
^$nu.current-exe --commands $'use std; NU_LOG_LEVEL=($system_level) std log ($message_level) --short "test message"'
^$nu.current-exe --commands $'use std; NU_log-level=($system_level) std log ($message_level) --short "test message"'
} else {
^$nu.current-exe --commands $'use std; NU_LOG_LEVEL=($system_level) std log ($message_level) "test message"'
^$nu.current-exe --commands $'use std; NU_log-level=($system_level) std log ($message_level) "test message"'
}
} | complete | get --ignore-errors stderr
}

15
crates/nu-std/tests/logger_tests/test_log_custom.nu
View File

@ -1,4 +1,5 @@
use std *
use std log *
use commons.nu *
def run-command [
@ -12,12 +13,12 @@ def run-command [
do {
if ($level_prefix | is-empty) {
if ($ansi | is-empty) {
^$nu.current-exe --commands $'use std; NU_LOG_LEVEL=($system_level) std log custom "($message)" "($format)" ($log_level)'
^$nu.current-exe --commands $'use std; NU_log-level=($system_level) std log custom "($message)" "($format)" ($log_level)'
} else {
^$nu.current-exe --commands $'use std; NU_LOG_LEVEL=($system_level) std log custom "($message)" "($format)" ($log_level) --ansi "($ansi)"'
^$nu.current-exe --commands $'use std; NU_log-level=($system_level) std log custom "($message)" "($format)" ($log_level) --ansi "($ansi)"'
}
} else {
^$nu.current-exe --commands $'use std; NU_LOG_LEVEL=($system_level) std log custom "($message)" "($format)" ($log_level) --level-prefix "($level_prefix)" --ansi "($ansi)"'
^$nu.current-exe --commands $'use std; NU_log-level=($system_level) std log custom "($message)" "($format)" ($log_level) --level-prefix "($level_prefix)" --ansi "($ansi)"'
}
} | complete | get --ignore-errors stderr
}
@ -32,13 +33,13 @@ def errors_during_deduction [] {
#[test]
def valid_calls [] {
assert equal (run-command "DEBUG" "msg" "%MSG%" 25 --level-prefix "abc" --ansi (ansi default) | str trim --right) "msg"
assert equal (run-command "DEBUG" "msg" "%LEVEL% %MSG%" 20 | str trim --right) $"($env.LOG_PREFIX.INFO) msg"
assert equal (run-command "DEBUG" "msg" "%LEVEL% %MSG%" 20 | str trim --right) $"((log-prefix).INFO) msg"
assert equal (run-command "DEBUG" "msg" "%LEVEL% %MSG%" --level-prefix "abc" 20 | str trim --right) "abc msg"
assert equal (run-command "INFO" "msg" "%ANSI_START%%LEVEL% %MSG%%ANSI_STOP%" $env.LOG_LEVEL.CRITICAL | str trim --right) $"($env.LOG_ANSI.CRITICAL)CRT msg(ansi reset)"
assert equal (run-command "INFO" "msg" "%ANSI_START%%LEVEL% %MSG%%ANSI_STOP%" ((log-level).CRITICAL) | str trim --right) $"((log-ansi).CRITICAL)CRT msg(ansi reset)"
}
#[test]
def log_level_handling [] {
assert equal (run-command "DEBUG" "msg" "%LEVEL% %MSG%" 20 | str trim --right) $"($env.LOG_PREFIX.INFO) msg"
def log-level_handling [] {
assert equal (run-command "DEBUG" "msg" "%LEVEL% %MSG%" 20 | str trim --right) $"((log-prefix).INFO) msg"
assert equal (run-command "WARNING" "msg" "%LEVEL% %MSG%" 20 | str trim --right) ""
}

13
crates/nu-std/tests/logger_tests/test_log_format_flag.nu
View File

@ -1,4 +1,5 @@
use std *
use std log *
use commons.nu *
def run-command [
@ -10,9 +11,9 @@ def run-command [
] {
do {
if $short {
^$nu.current-exe --commands $'use std; NU_LOG_LEVEL=($system_level) std log ($message_level) --format "($format)" --short "($message)"'
^$nu.current-exe --commands $'use std; NU_log-level=($system_level) std log ($message_level) --format "($format)" --short "($message)"'
} else {
^$nu.current-exe --commands $'use std; NU_LOG_LEVEL=($system_level) std log ($message_level) --format "($format)" "($message)"'
^$nu.current-exe --commands $'use std; NU_log-level=($system_level) std log ($message_level) --format "($format)" "($message)"'
}
} | complete | get --ignore-errors stderr
}
@ -26,14 +27,14 @@ def "assert formatted" [
] {
let output = (run-command "debug" $command_level $message --format $format)
let prefix = if $short {
($env.LOG_SHORT_PREFIX | get ($command_level | str upcase))
(log-short-prefix | get ($command_level | str upcase))
} else {
($env.LOG_PREFIX | get ($command_level | str upcase))
(log-prefix | get ($command_level | str upcase))
}
let ansi = if $short {
($env.LOG_ANSI | get ($command_level | str upcase))
(log-ansi | get ($command_level | str upcase))
} else {
($env.LOG_ANSI | get ($command_level | str upcase))
(log-ansi | get ($command_level | str upcase))
}
assert equal ($output | str trim --right) (format-message $message $format $prefix $ansi)

49
crates/nu-std/tests/logger_tests/test_logger_env.nu
View File

@ -1,39 +1,40 @@
use std *
use std log *
#[test]
def env_log_ansi [] {
assert equal $env.LOG_ANSI.CRITICAL (ansi red_bold)
assert equal $env.LOG_ANSI.ERROR (ansi red)
assert equal $env.LOG_ANSI.WARNING (ansi yellow)
assert equal $env.LOG_ANSI.INFO (ansi default)
assert equal $env.LOG_ANSI.DEBUG (ansi default_dimmed)
def env_log-ansi [] {
assert equal ((log-ansi).CRITICAL) (ansi red_bold)
assert equal ((log-ansi).ERROR) (ansi red)
assert equal ((log-ansi).WARNING) (ansi yellow)
assert equal ((log-ansi).INFO) (ansi default)
assert equal ((log-ansi).DEBUG) (ansi default_dimmed)
}
#[test]
def env_log_level [] {
assert equal $env.LOG_LEVEL.CRITICAL 50
assert equal $env.LOG_LEVEL.ERROR 40
assert equal $env.LOG_LEVEL.WARNING 30
assert equal $env.LOG_LEVEL.INFO 20
assert equal $env.LOG_LEVEL.DEBUG 10
def env_log-level [] {
assert equal ((log-level).CRITICAL) 50
assert equal ((log-level).ERROR) 40
assert equal ((log-level).WARNING) 30
assert equal ((log-level).INFO) 20
assert equal ((log-level).DEBUG) 10
}
#[test]
def env_log_prefix [] {
assert equal $env.LOG_PREFIX.CRITICAL "CRT"
assert equal $env.LOG_PREFIX.ERROR "ERR"
assert equal $env.LOG_PREFIX.WARNING "WRN"
assert equal $env.LOG_PREFIX.INFO "INF"
assert equal $env.LOG_PREFIX.DEBUG "DBG"
def env_log-prefix [] {
assert equal ((log-prefix).CRITICAL) "CRT"
assert equal ((log-prefix).ERROR) "ERR"
assert equal ((log-prefix).WARNING) "WRN"
assert equal ((log-prefix).INFO) "INF"
assert equal ((log-prefix).DEBUG) "DBG"
}
#[test]
def env_log_short_prefix [] {
assert equal $env.LOG_SHORT_PREFIX.CRITICAL "C"
assert equal $env.LOG_SHORT_PREFIX.ERROR "E"
assert equal $env.LOG_SHORT_PREFIX.WARNING "W"
assert equal $env.LOG_SHORT_PREFIX.INFO "I"
assert equal $env.LOG_SHORT_PREFIX.DEBUG "D"
def env_log-short-prefix [] {
assert equal ((log-short-prefix).CRITICAL) "C"
assert equal ((log-short-prefix).ERROR) "E"
assert equal ((log-short-prefix).WARNING) "W"
assert equal ((log-short-prefix).INFO) "I"
assert equal ((log-short-prefix).DEBUG) "D"
}
#[test]