fix(test): test clients should log to data_dir

[RolandSherwin]

Description

Summary generated by Reviewpad on 09 Oct 23 09:43 UTC

This pull request includes changes to multiple files. Here is a summary of the diff:

1. storage_payments.rs:

• Added a new function init_logging() that initializes logging to the data directory.
• The function checks if the SN_LOG environment variable is provided and overrides the logging targets accordingly.
• If the data directory exists, the function creates a log file with a timestamp in the directory data_dir/safe/client/logs.
• If the data directory does not exist, logging is set to stdout.
• The function init_logging() is called multiple times in different test functions.
• Overall, the changes seem to be related to storage payment functionalities and logging.

2. msgs_over_gossipsub.rs:

• Updated the import statement common::safenode_proto to crate::common::safenode_proto.
• Moved the import statement for sn_node::NodeEvent to a different location.
• Removed the usage of the NodeEvent type from the sn_node module.
• Added the import statement for eyre::Result.
• Some changes related to networking, including the definition of IP address and socket address.

3. Another file (not specified in the diff summary):

• Added an import statement for the init_logging function from the common module.
• Removed an import statement for the init_logging function from the sn_logging module.
• Removed an import statement for the Level type from the tracing_core module.
• Added a call to the init_logging function.
• Removed several lines related to setting up logging targets and log appender guard.
• Overall, the changes seem to be focused on modifying the logging configuration in the data_availability_during_churn test function.

4. sequential_transfers.rs:

• Removed unused imports (mod common, use sn_transfers::NanoTokens).
• Moved the import statement for common::{get_client_and_wallet, get_wallet, init_logging} to a different location.
• Reordered the import statements for sn_client::send and sn_transfers::{create_offline_transfer, rng, Hash, UniquePubkey}.
• Marked the test function cash_note_transfer_multiple_sequential_succeed as an async function.
• The changes seem to be focused on cleaning up unused imports and reorganizing the import statements.

5. verify_data_location.rs:

• Reorganized and updated imports.
• Modified the logging functionality, adjusting log targets and log levels.
• Modified the function verify_data_location.
• Removed the variable tmp_dir.
• Replaced the variable logging_targets with a call to init_logging.
• Updated the variable churn_count.
• Overall, the changes seem to be significant and might have an impact on the functionality of the code. Please review them carefully.

6. nodes_rewards.rs:

• Modified import statements, including adding new import statements and rearranging existing ones.
• Added the function init_logging() before the test function nodes_rewards_for_storing_chunks().
• Added the test function nodes_rewards_for_storing_registers() that includes a call to init_logging().
• Please review these changes in the test file nodes_rewards.rs.

Please review these file diffs and ensure they meet the requirements of the code.

[reviewpad]

Reviewpad Report

‼️ Errors

• Unconventional commit detected: 'fix(test): return log WorkerGuard

• the log file is empty if the guard is dropped' (3d9614b)

• Unconventional commit detected: 'fix(log): capture logs from tests

• if test-threads=1, only the logs from the test that calls init_logging() first are written
• this is because of the use of Once::new() during init_logging for tests' (191880d)

[grumbach]

LGTM