JDiskMark · vpstackhub · Oct 30, 2023 · Nov 4, 2023 · Nov 7, 2023 · Jan 11, 2024
diff --git a/.gitignore b/.gitignore
@@ -1,9 +1,9 @@
-/bdm.properties
 /dist/
 /nbproject/private/
 /build/
 /jdm.properties
 /tmp
 *.zip
-/build.properties
+*.patch
+build.properties
 /derbyDB/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,39 @@
+# How to contribute to JDiskMark
+
+First of all, thank you for considering a contribution to JDiskMark. We really appreciate the time and effort you want to spend improving the project, and we can use the help
+
+## What we are looking for
+
+- documentation (Getting Started guide, Examples, etc...)
+- bug reports
+- bug fixes
+- code quality improvements
+- features (both ideas and code are welcome)
+
+## Making your Changes
+
+Before you start, we recommend you open an issue for new features or bug fixes. This helps us coordinate and avoids duplicate work.
+
+1.  **Fork and Clone:** Start by forking the repository on GitHub and then clone your fork locally.
+
+2.  **Create a New Branch:** From the `dev` branch create a new, descriptively named branch for your changes:
+    `git checkout -b feature/your-awesome-feature`
+
+3.  **Code & Test:**
+    - Make your changes.
+    - Add test cases for new features or bug fixes.
+    - Test your build to make sure everything is still working.
+    - Please ensure your code is formatted correctly. If you're using NetBeans, you can use `Alt` + `Shift` + `F`.
+
+4.  **Commit Your Changes:**
+    - Write a clear and concise commit message. For example, "Fix: Corrected null pointer exception in DiskLogger" or "Feat: Added support for XFS filesystem."
+    - If you're fixing an issue, include the issue number and include `Closes#123` in your commit message to automatically close the issue when the PR is merged.
+    - If you have multiple commits, please squash them into a single one before submitting your pull request.
+
+## Submitting the Changes
+
+Submit a pull request via the normal GitHub UI.
+
+## After Submitting
+
+Do not use your branch for any other development, otherwise further changes that you make will be visible in the PR.
diff --git a/EmptyStandbyList.exe b/EmptyStandbyList.exe
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,48 @@
+JDiskMark 0.6.0 License Agreement
+NOTICE: This is a legal agreement. By using this software, you agree to be bound by the terms of this license.
+
+1. SCOPE OF LICENSE
+
+This software, JDiskMark (the "Software"), is licensed, not sold. The copyright holders reserve all rights not expressly granted to you. This license grants you a non-exclusive, worldwide, royalty-free license to use, copy, modify, and distribute the Software, subject to the terms and conditions outlined below.
+
+2. PERMISSIONS
+
+You are granted permission, free of charge, to any person obtaining a copy of this Software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to:
+
+Use the Software for personal and commercial purposes.
+
+Copy, modify, and merge the Software.
+
+Publish, distribute, and sublicense the Software.
+
+Sell copies of the Software.
+
+3. CONDITIONS
+
+The above permissions are subject to the following conditions:
+
+The original copyright notice and this permission notice must be included in all copies or substantial portions of the Software.
+
+You are not permitted to remove, minimize, block, or modify any notices or attributions of the original authors or copyright holders within the Software.
+
+You may not use the Software in any way that is unlawful or to create or propagate malware.
+
+4. DISCLAIMER OF WARRANTY
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+5. LIMITATION OF LIABILITY
+
+In no event shall the authors, copyright holders, or any other party involved in the creation or distribution of the Software be liable for any damages, including but not limited to direct, indirect, incidental, special, or consequential damages, arising out of the use or inability to use the Software.
+
+6. SUPPORT SERVICES
+
+The copyright holders are not obligated to provide any support services for the Software. Any support provided is "as is," "with all faults," and without warranty of any kind.
+
+7. TRANSFER TO ANOTHER DEVICE
+
+You may uninstall the Software and install it on another device for your use. You may not share this license on multiple devices.
+
+8. GOVERNING LAW
+
+This license agreement is governed by and construed in accordance with the laws of State of California, without regard to its conflict of law principles.
diff --git a/README.md b/README.md
@@ -1,53 +1,181 @@
-jDiskMark is a disk io utility written in java. 
+# JDiskMark v0.6.2 beta (Windows/Mac/Linux)
 
+Java Disk Benchmark Utility
 
-== Builds == 
+## Features
+
+- Java cross platform solution
+- Benchmark IO read/write performance
+- Graphs: sample bw, max, min, cum bw, latency (access time)
+- Adjustable block size, block qty and sample qty
+- Single or multi file option
+- Sequential or random option
+- Detect drive model, capacity and processor
+- Save and load benchmark
+- Auto clear disk cache (when sudo or admin)
+- multi threaded benchmarks
+
+## Releases
 
 https://sourceforge.net/projects/jdiskmark/
 
+## Installation
+
+Java 21 needs to be installed to run jdiskmark.
+
+1. Download and install [java 21](https://www.oracle.com/java/technologies/downloads/) from Oracle.
+
+2. Verify java 21 is installed:
+   ```
+   C:\Users\username>java --version
+   java 21.0.1 2023-10-17 LTS
+   Java(TM) SE Runtime Environment (build 21.0.1+12-LTS-29)
+   Java HotSpot(TM) 64-Bit Server VM (build 21.0.1+12-LTS-29, mixed mode, sharing)
+   ```
+
+3. Extract release zip archive into desired location.
+   ```
+   Examples:  
+   /Users/username/jdiskmark-v0.6.0
+   /opt/jdiskmark-v0.6.0
+   ```
+
+## Launching as normal process
+
+Note: Running without sudo or a windows administrator will require manually 
+clearing the disk write cache before performing read benchmarks.
+
+1. Open a terminal or shell in the extracted directory.
+
+2. run command:
+   ```
+   $ java -jar jdiskmark.jar
+   ```
+   In windows double click executable jar file.
+
+3. Drop cache manually:
+   - Linux: `sudo sh -c "sync; 1 > /proc/sys/vm/drop_caches"`
+   - Mac OS: `sudo sh -c "sync; purge"`
+   - Windows: Run included EmptyStandbyList.exe or [RAMMap64.exe](https://learn.microsoft.com/en-us/sysinternals/downloads/rammap)
+     - With RAMMap64 invalidate disk cache with Empty > Empty Standby List
+
+## Launching with elevated privileges
+
+Note: Take advantage of automatic clearing of the disk cache for write read 
+benchmarks start with sudo or an administrator windows shell.
+
+- Linux: `sudo java -jar jdiskmark.jar`
+- Mac OS: `sudo java -jar jdiskmark.jar`
+- Windows: start powershell as administrator then `java -jar jdiskmark.jar`
+
+## Development Environment
+
+jdiskmark client is developed with [NetBeans 21](https://netbeans.apache.org/front/main/download/) and [Java 21](https://www.oracle.com/java/technologies/downloads/)
+
+## Source
+
+Source code is available on our [github repo](https://github.com/JDiskMark/jdm-java/)
+
+## Release Notes
+
+### v1.0.0 planned
+- TODO: #16 MacOS installer - tyler
+- TODO: #15 Ubuntu installer - jeff
+- TODO: #33 maven build - lane
+- TODO: #40 gui presentation issues - james
+- #84 processor info resolved for (sp) installs
+- #73 refactor benchmark data model, keyboard op sel
+
+### v0.6.2 linux optimized ui
+- #64 persist IOPS, write sync - val
+- control panel on left
+- allow concurrent version runs
+- event tab swapped w disk location
+
+### v0.6.1 ms app store release
+- JDiskMark in title and msi vendor name
+- Remove "Average" from "Access Time" label
+
+### v0.6.0
+- #13 Detect drive info on startup
+- #12 update look and feel (windows)
+- #22 foreign capacity reporting
+- #23 delete selected benchmarks
+- #10 IOPS reporting
+- #25 linux crash, capacity w terabytes and exabytes
+- write sync default off
+- #26 lowercase project and jar
+- #20 threading and queue depth
+- #36 I/O Mode dropdown uses enum values for type safety
+
+### v0.5.1
+- resolve #17 invalid disk usage reported win 10
+- msi installer available
+
+### v0.5
+- update for java 21 LTS w NetBeans 20 environment: eclipselink 4.0, jpa 3.1, 
+  modelgen 5.6, annotations 3.1, xml.bind 4.0
+- increased drive information default col width to 170
+- time format updated to `yyyy-MM-dd HH:mm:ss`
+- default to 200 marks
+- replace Date w LocalDateTime to avoid deprecated @Temporal
+- disk access time (ms) - plotting disabled by default
+- replace display of transfer size with access time in run panel
+- GH-2 auto clear disk cache for combined write read benchmarks
+- GH-6 save and load benchmarks and graph series
+- break out actions into seperate menu
+- admin or root indicator, architecture indicator
+- GH-8 used capacity and total capacity
+- initial color palette options
+- report processor name
+
+### v0.4
+- updated eclipselink to 2.6 allows auto schema update
+- improved gui initialization
+- platform disk model info:
+  - windows: via powershell query
+  - linux:   via `df /data/path` & `lsblk /dev/path --output MODEL`
+  - osx:     via `df /data/path` & `diskutil info /dev/disk1`
+
+### v0.3
+- persist recent run with embedded derby db
+- remove "transfer mark number" from graph
+- changed graph background to dark gray
+- resizing main frame stretches tabbed pane instead of empty panel
 
-== Usage ==
+### v0.2
+- auto generate zip release ie. `jdiskmark-v0.2.zip`
+- added tabbed pane near bottom to organize new controls
+- format excessive decimal places
+- show recent runs (not persisted)
+- default to nimbus look and feel
 
-1. Requires java 8.
+### v0.1
+- initial release
 
-2. to run:
-
-   $ java -jar jDiskMark.jar
+### Proposed Features
+- upload benchmarks to jdiskmark.net portal (anonymous/w login)
+- local app log for remote diagnostics
+- selecting a drive location displays detected drive information below
+- speed curves w rw at different tx sizes
+- response time histogram > distribution of IO
+- IOPS charts, review potential charts
+- help that describes features and controls
 
-   On windows double click executable jar file.
+## issues
+- read&write not consistant with order caps
+- bottom margins between table to bar to window edge should be the same
 
+## Windows Paths Examples for Building
 
-== Release Notes ==
+For ant builds
 
-v0.1
- - initial release
+`C:\apache-ant-1.10.15\bin`
 
-v0.2
- - auto generate zip release ie. jdiskmark-v0.2.zip
- - added tabbed pane near bottom to organize new controls
- - format excessive decimal places
- - show recent runs (not persisted)
- - default to nimbus look and feel
+For maven builds
 
-v0.3
- - persist recent run with embedded derby db
- - remove "transfer mark number" from graph
- - changed graph background to dark gray
- - resizing main frame stretches tabbed pane instead of empty panel
+`C:\apache-maven-3.9.10\bin`
 
-v0.4
- - updated eclipselink to 2.6 allows auto schema update
- - improved gui initialization
- - platform disk model info: 
-     windows: via powershell query
-     linux:   via "df /data/path" & "lsblk /dev/path --output MODEL"
-     osx:     via "df /data/path" & "diskutil info /dev/disk1"
+For code signing
 
-desired features
- - update windows drive model parsing script to adapt to differing script output
- - disk access time (ms)
- - disk capacity and drive letter (available on windows)
- - auto clear disk cache windows, linux, osx
-     linux: sync && echo 1 > /proc/sys/vm/drop_caches
-     windows: ???
-     osx: ???
+`C:\Program Files (x86)\Windows Kits\10\bin\10.0.26100.0\x86\`
diff --git a/archive/package-msi.bat b/archive/package-msi.bat
@@ -0,0 +1,16 @@
+:: GH-14 This script uses jpackage w wix 3.14 to create a msi installer
+:: wix toolset 3.14 is available here:
+:: https://github.com/wixtoolset/wix3/releases/tag/wix3141rtm
+
+:: make sure to set the version number
+set VERSION=0.6.0-dev.g
+set MSI_VER=0.6.0
+
+set JPKG_EXE="C:\Program Files\java\jdk-21\bin\jpackage"
+
+del jdiskmark-*.msi
+%JPKG_EXE% --type msi --input jdiskmark-%VERSION% --main-jar jdiskmark.jar ^
+    --name jdiskmark-%VERSION% --app-version %MSI_VER% ^
+    --vendor "jdiskmark.net" --win-console --win-menu
+
+ren jdiskmark-%VERSION%-%MSI_VER%.msi jdiskmark-%VERSION%.msi
diff --git a/archive/sign-msi.bat b/archive/sign-msi.bat
@@ -0,0 +1,4 @@
+:: script to sign msi file
+:: 
+
+"C:\Program Files (x86)\Windows Kits\10\bin\10.0.22621.0\x86\signtool.exe" sign /tr http://timestamp.sectigo.com /td sha256 /fd sha256 /a "jdiskmark-0.6.0-dev.h.msi"