FilesExpand file tree

develop

/

gain_hook_warning_test.rs

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

272 lines (248 loc) · 8.37 KB

develop

/

gain_hook_warning_test.rs

Copy path

Top

File metadata and controls

• Code
• Blame

272 lines (248 loc) · 8.37 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

//! Integration tests: `rtk gain` hook-status warning coverage.

//!

//! Matrix contributed by @AngelVRodC in rtk-ai/rtk#4039.

//!

//! Change: fix-gain-hook-warning (rtk-ai/rtk#4035) — the missing-hook warning

//! must appear on every text view (default, --daily, --weekly, --monthly,

//! --all) and on the empty-database report, exactly once per invocation.

//! JSON/CSV exports stay warning-free; the not-applicable state (no ~/.claude)

//! stays silent.

#![cfg(unix)]

use std::path::Path;

use tempfile::TempDir;

mod common;

const NEEDLE: &str = "[warn] No hook installed";

/// Pins every directory the binary resolves from the environment, so a runner

/// that exports `XDG_*` cannot reach past the temporary home.

fn isolating_env(home: &Path) -> Vec<(String, std::ffi::OsString)> {

vec![

("HOME".into(), home.as_os_str().to_owned()),

("RTK_DB_PATH".into(), home.join("rtk.db").into_os_string()),

(

"XDG_CONFIG_HOME".into(),

home.join(".config").into_os_string(),

),

(

"XDG_DATA_HOME".into(),

home.join(".local").join("share").into_os_string(),

),

]

}

/// Run `rtk gain <args>` with HOME isolated to `home`, returning

/// (stdout, stderr) as lossy UTF-8 strings.

fn gain_split(args: &[&str], home: &Path) -> (String, String) {

gain_split_env(args, home, &[])

}

/// As `gain_split`, with extra environment variables applied.

fn gain_split_env(args: &[&str], home: &Path, env: &[(&str, &str)]) -> (String, String) {

// `rtk_command` clears the inherited `RTK_*` and agent-home variables and

// pins rtk's own paths; `isolating_env` then moves them onto this test's

// temporary home. `LC_ALL` is this test's to set: it reads rtk's own

// wording, not a native tool's.

let mut cmd = common::rtk_command();

cmd.args(args).envs(isolating_env(home)).env("LC_ALL", "C");

for (key, value) in env {

cmd.env(key, value);

}

let output = cmd.output().expect("spawn rtk gain");

assert!(

output.status.success(),

"rtk gain {} failed: {}",

args.join(" "),

String::from_utf8_lossy(&output.stderr)

);

(

String::from_utf8_lossy(&output.stdout).into_owned(),

String::from_utf8_lossy(&output.stderr).into_owned(),

)

}

/// Combined stdout+stderr (ANSI codes wrap, never split, the needle).

fn gain(args: &[&str], home: &Path) -> String {

let (out, err) = gain_split(args, home);

format!("{out}{err}")

}

fn count(haystack: &str, needle: &str) -> usize {

haystack.matches(needle).count()

}

/// HOME with a `.claude` dir but no hook registered → status() == Missing.

fn missing_hook_home() -> TempDir {

let tmp = tempfile::tempdir().expect("tempdir");

std::fs::create_dir_all(tmp.path().join(".claude")).expect("create .claude");

tmp

}

/// Missing-hook home plus one tracked record (via `rtk proxy true`, which

/// records usage with 0% reduction).

fn seeded_home() -> TempDir {

let tmp = missing_hook_home();

let out = common::rtk_command()

.args(["proxy", "true"])

.envs(isolating_env(tmp.path()))

.env("LC_ALL", "C")

.output()

.expect("spawn rtk proxy seed");

assert!(

out.status.success(),

"rtk proxy true failed: {}",

String::from_utf8_lossy(&out.stderr)

);

tmp

}

#[test]

fn default_view_with_data_warns_exactly_once_on_stderr() {

let home = seeded_home();

let (stdout, stderr) = gain_split(&["gain"], home.path());

assert_eq!(

count(&format!("{stdout}{stderr}"), NEEDLE),

1,

"warning must appear exactly once"

);

assert!(

!stdout.contains(NEEDLE),

"warning must be routed to stderr, not stdout"

);

}

#[test]

fn daily_view_warns_exactly_once() {

let home = seeded_home();

assert_eq!(count(&gain(&["gain", "--daily"], home.path()), NEEDLE), 1);

}

#[test]

fn weekly_view_warns_exactly_once() {

let home = seeded_home();

assert_eq!(count(&gain(&["gain", "--weekly"], home.path()), NEEDLE), 1);

}

#[test]

fn monthly_view_warns_exactly_once() {

let home = seeded_home();

assert_eq!(count(&gain(&["gain", "--monthly"], home.path()), NEEDLE), 1);

}

#[test]

fn all_view_warns_exactly_once() {

let home = seeded_home();

assert_eq!(count(&gain(&["gain", "--all"], home.path()), NEEDLE), 1);

}

#[test]

fn empty_database_still_warns_once() {

// The rtk-ai/rtk#4035 regression: empty tracking data must not swallow

// the hook warning (it explains WHY there is no data).

let home = missing_hook_home();

assert_eq!(count(&gain(&["gain"], home.path()), NEEDLE), 1);

}

#[test]

fn json_export_is_warning_free() {

let home = seeded_home();

let (stdout, stderr) = gain_split(&["gain", "--format", "json"], home.path());

let combined = format!("{stdout}{stderr}");

assert_eq!(count(&combined, NEEDLE), 0);

assert!(

!combined.contains("[warn]"),

"no warning text in JSON export"

);

assert!(

stdout.trim_start().starts_with('{'),

"JSON export must start with '{{': {stdout}"

);

}

#[test]

fn csv_export_is_warning_free() {

let home = seeded_home();

let combined = gain(&["gain", "--format", "csv"], home.path());

assert_eq!(count(&combined, NEEDLE), 0);

assert!(

!combined.contains("[warn]"),

"no warning text in CSV export"

);

}

#[test]

fn no_claude_dir_stays_silent() {

// Not-applicable state: bare HOME without ~/.claude → status() == Ok.

let tmp = seeded_home_bare();

let combined = gain(&["gain"], tmp.path());

assert_eq!(

count(&combined, NEEDLE),

0,

"no ~/.claude dir must stay silent"

);

}

/// Bare HOME (no `.claude`) with one tracked record.

fn seeded_home_bare() -> TempDir {

let tmp = tempfile::tempdir().expect("tempdir");

let out = common::rtk_command()

.args(["proxy", "true"])

.envs(isolating_env(tmp.path()))

.env("LC_ALL", "C")

.output()

.expect("spawn rtk proxy seed");

assert!(

out.status.success(),

"rtk proxy true failed: {}",

String::from_utf8_lossy(&out.stderr)

);

tmp

}

/// Missing-hook home plus a legacy hook script with no version tag, which

/// `parse_hook_version` reads as version 0 → `status() == Outdated`.

fn outdated_hook_home() -> TempDir {

let tmp = seeded_home();

let hooks = tmp.path().join(".claude").join("hooks");

std::fs::create_dir_all(&hooks).expect("create hooks dir");

std::fs::write(

hooks.join("rtk-rewrite.sh"),

b"#!/usr/bin/env bash\n# no version tag\n",

)

.expect("write legacy hook");

tmp

}

#[test]

fn suppress_hook_warning_hides_the_missing_arm_on_every_view() {

// `suppress_hook_warning` is for users who run rtk without hooks on

// purpose. Hoisting the check out of the default-view branch must not

// hand them the warning back on the views that were previously silent.

let home = seeded_home();

for args in [

vec!["gain"],

vec!["gain", "--daily"],

vec!["gain", "--weekly"],

vec!["gain", "--monthly"],

vec!["gain", "--all"],

] {

let (stdout, stderr) =

gain_split_env(&args, home.path(), &[("RTK_SUPPRESS_HOOK_WARNING", "1")]);

assert_eq!(

count(&format!("{stdout}{stderr}"), NEEDLE),

0,

"rtk {} must stay silent when suppressed",

args.join(" ")

);

}

}

#[test]

fn suppress_hook_warning_does_not_hide_an_outdated_hook() {

// Only the missing-hook arm is suppressible; an outdated hook is a

// correctness problem the user has not opted out of.

let home = outdated_hook_home();

let (stdout, stderr) = gain_split_env(

&["gain"],

home.path(),

&[("RTK_SUPPRESS_HOOK_WARNING", "1")],

);

let combined = format!("{stdout}{stderr}");

assert_eq!(

count(&combined, "[warn] Hook outdated"),

1,

"outdated hook must still be reported under suppression: {combined}"

);

}

#[test]

fn an_outdated_hook_is_reported_on_every_view() {

let home = outdated_hook_home();

for args in [vec!["gain"], vec!["gain", "--daily"], vec!["gain", "--all"]] {

let combined = gain(&args, home.path());

assert_eq!(

count(&combined, "[warn] Hook outdated"),

1,

"rtk {} must report the outdated hook exactly once",

args.join(" ")

);

}

}