This repository was archived by the owner on Nov 15, 2023. It is now read-only.
  
  
  - 
                Notifications
    You must be signed in to change notification settings 
- Fork 2.7k
Fixes logging of target names with dashes #7281
          
     Merged
      
      
    
  
     Merged
                    Changes from all commits
      Commits
    
    
  File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
      
      Oops, something went wrong.
      
    
  
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
|  | @@ -333,10 +333,11 @@ pub fn init_logger( | |
| mod tests { | ||
| use super::*; | ||
| use tracing::{metadata::Kind, subscriber::Interest, Callsite, Level, Metadata}; | ||
| use std::{process::Command, env}; | ||
|  | ||
| #[test] | ||
| fn test_logger_filters() { | ||
| let test_pattern = "afg=debug,sync=trace,client=warn,telemetry"; | ||
| let test_pattern = "afg=debug,sync=trace,client=warn,telemetry,something-with-dash=error"; | ||
| init_logger(&test_pattern, Default::default(), Default::default()).unwrap(); | ||
|  | ||
| tracing::dispatcher::get_default(|dispatcher| { | ||
|  | @@ -369,6 +370,36 @@ mod tests { | |
| assert!(test_filter("client", Level::WARN)); | ||
|  | ||
| assert!(test_filter("telemetry", Level::TRACE)); | ||
| assert!(test_filter("something-with-dash", Level::ERROR)); | ||
| }); | ||
| } | ||
|  | ||
| const EXPECTED_LOG_MESSAGE: &'static str = "yeah logging works as expected"; | ||
|  | ||
| #[test] | ||
| fn dash_in_target_name_works() { | ||
| There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nice test :) | ||
| let executable = env::current_exe().unwrap(); | ||
| let output = Command::new(executable) | ||
| .env("ENABLE_LOGGING", "1") | ||
| .args(&["--nocapture", "log_something_with_dash_target_name"]) | ||
| .output() | ||
| .unwrap(); | ||
|  | ||
| let output = String::from_utf8(output.stderr).unwrap(); | ||
| assert!(output.contains(EXPECTED_LOG_MESSAGE)); | ||
| } | ||
|  | ||
| /// This is no actual test, it will be used by the `dash_in_target_name_works` test. | ||
| /// The given test will call the test executable to only execute this test that | ||
| /// will only print `EXPECTED_LOG_MESSAGE` through logging while using a target | ||
| /// name that contains a dash. This ensures that targets names with dashes work. | ||
| #[test] | ||
| fn log_something_with_dash_target_name() { | ||
| if env::var("ENABLE_LOGGING").is_ok() { | ||
| let test_pattern = "test-target=info"; | ||
| init_logger(&test_pattern, Default::default(), Default::default()).unwrap(); | ||
|  | ||
| log::info!(target: "test-target", "{}", EXPECTED_LOG_MESSAGE); | ||
| } | ||
| } | ||
| } | ||
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we can also add an example with dashes to this test 🤷
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added