wip: benchmarking

Author: omarabid

Cargo.toml

@@ -15,6 +15,11 @@ code input cli.
 name = "ci"
 path = "src/main.rs"
 
+[[bench]]
+name = "parser_bench"
+path = "src/benches/parser_bench.rs"
+harness = false
+
 [features]
 nightly = []
 termlog = ["slog-term"]
@@ -55,6 +60,7 @@ features = ["cargo", "derive"]
 assert_cmd = "2.0.17"
 predicates = "3.1.3"
 tempfile = "3.20"
+criterion = { version = "0.6.0", features = ["html_reports"] }
 
 [profile.dev]
 opt-level = 0

src/benches/mod.rs

@@ -0,0 +1 @@
+pub(crate) mod parser_bench;

src/benches/parser_bench.rs

@@ -0,0 +1,20 @@
+use codeinput::core::parser::parse_line;
+use criterion::{Criterion, black_box, criterion_group, criterion_main};
+use std::path::Path;
+
+fn bench_parse_line_simple(c: &mut Criterion) {
+    let source_path = Path::new("/test/CODEOWNERS");
+
+    c.bench_function("parse_line_simple", |b| {
+        b.iter(|| {
+            parse_line(
+                black_box("*.js @user"),
+                black_box(1),
+                black_box(source_path),
+            )
+        })
+    });
+}
+
+criterion_group!(benches, bench_parse_line_simple);
+criterion_main!(benches);

src/core/mod.rs

@@ -1,10 +1,10 @@
-pub mod cache;
-pub mod commands;
-pub mod common;
-pub mod parse;
+pub(crate) mod cache;
+pub(crate) mod commands;
+pub(crate) mod common;
+pub(crate) mod parse;
 pub mod parser;
-pub mod resolver;
-pub mod types;
+pub(crate) mod resolver;
+pub(crate) mod types;
 
 use crate::utils::error::Result;
 

src/core/parser.rs

@@ -4,7 +4,7 @@ use std::path::Path;
 use super::types::{CodeownersEntry, Owner, OwnerType, Tag};
 
 /// Parse CODEOWNERS
-pub fn parse_codeowners(source_path: &Path) -> Result<Vec<CodeownersEntry>> {
+pub(crate) fn parse_codeowners(source_path: &Path) -> Result<Vec<CodeownersEntry>> {
     let content = std::fs::read_to_string(source_path)?;
 
     content
@@ -15,7 +15,7 @@ pub fn parse_codeowners(source_path: &Path) -> Result<Vec<CodeownersEntry>> {
 }
 
 /// Parse a line of CODEOWNERS
-pub(crate) fn parse_line(
+pub fn parse_line(
     line: &str, line_num: usize, source_path: &Path,
 ) -> Result<Option<CodeownersEntry>> {
     // Trim the line and check for empty or comment lines
@@ -77,7 +77,7 @@ pub(crate) fn parse_line(
 }
 
 /// Parse an owner string into an Owner struct
-fn parse_owner(owner_str: &str) -> Result<Owner> {
+pub(crate) fn parse_owner(owner_str: &str) -> Result<Owner> {
     let identifier = owner_str.to_string();
     let owner_type = if identifier.eq_ignore_ascii_case("NOOWNER") {
         OwnerType::Unowned

src/lib.rs

@@ -1,3 +1,3 @@
 pub(crate) mod cli;
-pub(crate) mod core;
+pub mod core;
 pub(crate) mod utils;