Find TestLog

This is a utility developed in Rust & Tauri Framework, designed to assist in finding and opening log files in a complex directory structure. This tool can be extremely useful if you have a directory structure based on product numbers, year-weeks, and test environments. The application uses a configuration file to save and reuse settings, enhancing its usability.

Features

• Search for log files based on parameters like drive letter, folder location, product number, year-week, test environment, and serial number.
• Automatically open the found log files (optional).
• Store the last used parameters in a configuration file for future use. These stored parameters will be used for subsequent searches unless new ones are provided.
• Retrieve the location of the configuration file.
• Command-line arguments take precedence over the configuration file.
• Load and save application configuration from a file.
• Easy interaction through a command-line interface.

Commandline Usage <WARNING NO LONGER SUPPORT SINCE 2.4.0>

The application accepts several command-line arguments:

-p, --pn <pn>: Product Number (Example: 9999-1234-5678).
-s, --sn <sn>: Serial Number (Example: xx-xx-yyy-000).
-y, --year_week <year_week>: Year Week (Example: 2023-W51). Defaults to searching all year-week folders.
-t, --test_env <test_env>: Test environment. Default is PTF.
-d, --drive_letter <drive_letter>: Drive letter. Default is Q:.
-f, --folder_location <folder_location>: Folder location. Default is TestLogs.
-g, --get_config_location: If passed, Returns config location.

If the tool has been run at least once, and no arguments are provided for the subsequent run, it will utilize the parameters stored in the configuration file from the last run:

./target/release/find-testlog

Getting Started

To use this tool, you need to have Rust installed on your system. If you don't, visit rust-lang.org/tools/install to install Rust.

Once you have Rust installed, you can clone this repository and build the project:

git clone https://github.com/yourusername/find-testlog.git
cd find-testlog
npm run tauri init
npm run tauri build

Or You can download the latest version from the releases page.

Quickstart

Now you can run the utility (from the project root):

./target/release/find-testlog -d "D:" -f "TestLogs" -p "REPLACE_PRODUCT_NUMBER" -y "2023-W51" -t "PTF" -s "REPLACE_SERIAL_NUMBER"

output:
$ #1 D:\TestLogs\REPLACE_PRODUCT_NUMBER\2023-W51\PTF\20230515_105021_CLNTXXXX_group_0_REPLACE_SERIAL_NUMBER.log
$ #2 D:\TestLogs\REPLACE_PRODUCT_NUMBER\2023-W51\PTF\20240515_105021_CLNTXXXX_group_0_REPLACE_SERIAL_NUMBER.log
$ Please select #.. to open

Only passing the SN or PN will make the CLI tool search all folders.

./target/release/find-testlog -s "REPLACE_SERIAL_NUMBER"

output:
Matched log file paths:
$ #1 D:\TestLogs\REPLACE_PRODUCT_NUMBER\2023-W20\PTF\20230515_105021_CLNTXXXX_group_0_REPLACE_SERIAL_NUMBER - Copy.log
$ #2 D:\TestLogs\REPLACE_PRODUCT_NUMBER\2023-W20\PTF\20230515_105021_CLNTXXXX_group_0_REPLACE_SERIAL_NUMBER.log
$ #3 D:\TestLogs\REPLACE_PRODUCT_NUMBER\2023-W51\PTF\20230515_105021_CLNTXXXX_group_0_REPLACE_SERIAL_NUMBER.log
$ #4 D:\TestLogs\REPLACE_PRODUCT_NUMBER\2023-W51\PTF\20240515_105021_CLNTXXXX_group_0_REPLACE_SERIAL_NUMBER.log
$ Please select #.. to open

Overwrite configuration

If you wish to override some or all parameters stored in the configuration file, simply provide the new values as command-line arguments. For example:

./target/release/find-testlog -p "REPLACE_PRODUCT_NUMBER"

In this case, find-testlog will use the new product number but will pull all other parameters from the configuration file.

To see where your configuration file is located, run:

./target/release/find-testlog --get-config-location

Configuration file is located at: "C:\\Users\\User\\AppData\\Roaming\\find_testlog\\config\\default-config.toml"

The configuration file can be edited manually if needed. However, it is recommended to change parameters using the command-line arguments, as this ensures that the configuration file remains in a valid state.

Remember, the use of the configuration file can streamline your workflow, particularly when frequently searching for log files with the same parameters.

Dependencies

• Tauri: Build an optimized, secure, and frontend-independent application for multi-platform deployment.
• clap: For building command-line interfaces.
• confy: For handling application configuration.
• serde: For serializing and deserializing Rust data structures.
• colored: For coloring terminal text.
• walkdir: For walking directory trees.
• open: path or URL using the program configured on the system.
• log: A Rust library providing a lightweight logging facade.
• windows-sys: Windows API.
• Regex: Regex...
• Chrono: Operations on dates and time.
• Indexmap: hash table where the iteration order of the key-value pairs is independent of the hash values of the keys.

Contribution

This project is licensed under the GNU General Public License v3.0 License - see the LICENSE file for details.

Special thanks

• Alex Nolan
  • Solved bug
  • Tested on his machine