|
| 1 | +import { expect } from 'chai'; |
| 2 | +import { readFileSync } from 'fs'; |
| 3 | +import { fileURLToPath } from 'url'; |
| 4 | +import { dirname, join } from 'path'; |
| 5 | + |
| 6 | +/** |
| 7 | + * Help Text Template Tests (SLAC-9) |
| 8 | + * |
| 9 | + * Verifies that: |
| 10 | + * 1. The featurerequest command description reads exactly: |
| 11 | + * "Wish for what new feature this bot should have!!!" |
| 12 | + * 2. No other command descriptions were altered as a side effect. |
| 13 | + * 3. All expected command sections and entries are present. |
| 14 | + * 4. Handlebars-style placeholders used by both Slack and Discord are intact. |
| 15 | + * 5. The file can be read without errors (bot can start). |
| 16 | + */ |
| 17 | + |
| 18 | +const __filename = fileURLToPath(import.meta.url); |
| 19 | +const __dirname = dirname(__filename); |
| 20 | + |
| 21 | +const HELP_TEXT_PATH = join(__dirname, '..', 'templates', 'help', 'helpText.txt'); |
| 22 | + |
| 23 | +// Read once for all tests |
| 24 | +let helpText; |
| 25 | +try { |
| 26 | + helpText = readFileSync(HELP_TEXT_PATH, 'utf8'); |
| 27 | +} catch (err) { |
| 28 | + helpText = null; |
| 29 | +} |
| 30 | + |
| 31 | +// ─── SLAC-9: featurerequest description ────────────────────────────────────── |
| 32 | + |
| 33 | +describe('helpText.txt — SLAC-9: featurerequest description', function () { |
| 34 | + |
| 35 | + it('should be readable without errors', function () { |
| 36 | + expect(helpText).to.be.a('string'); |
| 37 | + expect(helpText.length).to.be.greaterThan(0); |
| 38 | + }); |
| 39 | + |
| 40 | + it('should contain the exact new featurerequest description text', function () { |
| 41 | + expect(helpText).to.include('Wish for what new feature this bot should have!!!'); |
| 42 | + }); |
| 43 | + |
| 44 | + it('should NOT contain the old featurerequest description text', function () { |
| 45 | + expect(helpText).to.not.include('Create a GitHub issue for a feature request.'); |
| 46 | + }); |
| 47 | + |
| 48 | + it('should list featurerequest command with its "fr" alias', function () { |
| 49 | + expect(helpText).to.match(/`featurerequest`\s*\(or\s*`fr`\)/); |
| 50 | + }); |
| 51 | + |
| 52 | + it('should include the feature description argument placeholder', function () { |
| 53 | + expect(helpText).to.include('<feature description>'); |
| 54 | + }); |
| 55 | + |
| 56 | + it('should have the featurerequest entry in the Feedback section', function () { |
| 57 | + const feedbackSectionStart = helpText.indexOf('*📝 Feedback:*'); |
| 58 | + expect(feedbackSectionStart).to.be.greaterThan(-1, 'Feedback section header not found'); |
| 59 | + |
| 60 | + const featureRequestIndex = helpText.indexOf('featurerequest', feedbackSectionStart); |
| 61 | + expect(featureRequestIndex).to.be.greaterThan( |
| 62 | + feedbackSectionStart, |
| 63 | + 'featurerequest entry should appear after the Feedback section header' |
| 64 | + ); |
| 65 | + }); |
| 66 | + |
| 67 | + it('should have the new description on the same line as the featurerequest command entry', function () { |
| 68 | + const lines = helpText.split('\n'); |
| 69 | + const featureRequestLine = lines.find(line => line.includes('featurerequest') && line.includes('fr')); |
| 70 | + expect(featureRequestLine).to.be.a('string', 'Could not find the featurerequest command line'); |
| 71 | + expect(featureRequestLine).to.include('Wish for what new feature this bot should have!!!'); |
| 72 | + }); |
| 73 | + |
| 74 | + it('should have exactly one featurerequest entry', function () { |
| 75 | + const matches = helpText.match(/`featurerequest`/g); |
| 76 | + expect(matches).to.not.be.null; |
| 77 | + expect(matches.length).to.equal(1); |
| 78 | + }); |
| 79 | +}); |
| 80 | + |
| 81 | +// ─── Section headers ───────────────────────────────────────────────────────── |
| 82 | + |
| 83 | +describe('helpText.txt — Section headers are intact', function () { |
| 84 | + |
| 85 | + it('should contain the Music Commands section header', function () { |
| 86 | + expect(helpText).to.include('*🎵 Music Commands:*'); |
| 87 | + }); |
| 88 | + |
| 89 | + it('should contain the Info Commands section header', function () { |
| 90 | + expect(helpText).to.include('*ℹ️ Info Commands:*'); |
| 91 | + }); |
| 92 | + |
| 93 | + it('should contain the Voting Commands section header', function () { |
| 94 | + expect(helpText).to.include('*🗳️ Voting Commands:*'); |
| 95 | + }); |
| 96 | + |
| 97 | + it('should contain the Feedback section header', function () { |
| 98 | + expect(helpText).to.include('*📝 Feedback:*'); |
| 99 | + }); |
| 100 | +}); |
| 101 | + |
| 102 | +// ─── Music commands unchanged ───────────────────────────────────────────────── |
| 103 | + |
| 104 | +describe('helpText.txt — Music command descriptions are unchanged', function () { |
| 105 | + |
| 106 | + it('should contain the add command description', function () { |
| 107 | + expect(helpText).to.include('`add [track]`'); |
| 108 | + expect(helpText).to.include('Add a track (search term, Spotify URI, or link). When stopped, starts a fresh queue.'); |
| 109 | + }); |
| 110 | + |
| 111 | + it('should contain the append command description', function () { |
| 112 | + expect(helpText).to.include('`append [track]`'); |
| 113 | + expect(helpText).to.include('Add a track (search term, Spotify URI, or link) without clearing the queue.'); |
| 114 | + }); |
| 115 | + |
| 116 | + it('should contain the addalbum command description', function () { |
| 117 | + expect(helpText).to.include('`addalbum [album]`'); |
| 118 | + expect(helpText).to.include('Add an entire album (search term, Spotify URI, or link) to the queue.'); |
| 119 | + }); |
| 120 | + |
| 121 | + it('should contain the addplaylist command description', function () { |
| 122 | + expect(helpText).to.include('`addplaylist [playlist]`'); |
| 123 | + expect(helpText).to.include('Add an entire playlist (search term, Spotify URI, or link) to the queue.'); |
| 124 | + }); |
| 125 | + |
| 126 | + it('should contain the search command description with searchLimit placeholder', function () { |
| 127 | + expect(helpText).to.include('`search [track]`'); |
| 128 | + expect(helpText).to.include('{{searchLimit}}'); |
| 129 | + }); |
| 130 | + |
| 131 | + it('should contain the searchalbum command description', function () { |
| 132 | + expect(helpText).to.include('`searchalbum [album]`'); |
| 133 | + expect(helpText).to.include('Search for an album on Spotify.'); |
| 134 | + }); |
| 135 | + |
| 136 | + it('should contain the searchplaylist command description', function () { |
| 137 | + expect(helpText).to.include('`searchplaylist [playlist]`'); |
| 138 | + expect(helpText).to.include('Search for a playlist on Spotify.'); |
| 139 | + }); |
| 140 | +}); |
| 141 | + |
| 142 | +// ─── Info commands unchanged ────────────────────────────────────────────────── |
| 143 | + |
| 144 | +describe('helpText.txt — Info command descriptions are unchanged', function () { |
| 145 | + |
| 146 | + it('should contain the current / wtf command description', function () { |
| 147 | + expect(helpText).to.include('`current` (or `wtf`)'); |
| 148 | + expect(helpText).to.include("Show what's currently playing."); |
| 149 | + }); |
| 150 | + |
| 151 | + it('should contain the list / ls / playlist command description', function () { |
| 152 | + expect(helpText).to.include('`list` (or `ls`, `playlist`)'); |
| 153 | + expect(helpText).to.include('Show the entire queue.'); |
| 154 | + }); |
| 155 | + |
| 156 | + it('should contain the upnext command description', function () { |
| 157 | + expect(helpText).to.include('`upnext`'); |
| 158 | + expect(helpText).to.include('Show the next 5 tracks.'); |
| 159 | + }); |
| 160 | + |
| 161 | + it('should contain the size / count command description', function () { |
| 162 | + expect(helpText).to.include('`size` (or `count`)'); |
| 163 | + expect(helpText).to.include('Get the number of songs in the queue.'); |
| 164 | + }); |
| 165 | + |
| 166 | + it('should contain the volume command description', function () { |
| 167 | + expect(helpText).to.include('`volume`'); |
| 168 | + expect(helpText).to.include('Get the current volume level.'); |
| 169 | + }); |
| 170 | + |
| 171 | + it('should contain the status command description', function () { |
| 172 | + expect(helpText).to.include('`status`'); |
| 173 | + expect(helpText).to.include('Get the current playback status.'); |
| 174 | + }); |
| 175 | + |
| 176 | + it('should contain the bestof command description', function () { |
| 177 | + expect(helpText).to.include('`bestof [user]`'); |
| 178 | + expect(helpText).to.include('Show the top tracks added by a user.'); |
| 179 | + }); |
| 180 | +}); |
| 181 | + |
| 182 | +// ─── Voting commands unchanged ──────────────────────────────────────────────── |
| 183 | + |
| 184 | +describe('helpText.txt — Voting command descriptions are unchanged', function () { |
| 185 | + |
| 186 | + it('should contain the gong / dong command description with gongLimit placeholder', function () { |
| 187 | + expect(helpText).to.include('`gong` (or `dong`)'); |
| 188 | + expect(helpText).to.include('Vote to skip the current track. Needs *{{gongLimit}}* votes.'); |
| 189 | + }); |
| 190 | + |
| 191 | + it('should contain the gongcheck command description', function () { |
| 192 | + expect(helpText).to.include('`gongcheck`'); |
| 193 | + expect(helpText).to.include('Check how many GONG votes are remaining.'); |
| 194 | + }); |
| 195 | + |
| 196 | + it('should contain the voteimmune command description with voteImmuneLimit placeholder', function () { |
| 197 | + expect(helpText).to.include('`voteimmune [position]`'); |
| 198 | + expect(helpText).to.include('Protect a track from being gonged. Needs *{{voteImmuneLimit}}* votes.'); |
| 199 | + }); |
| 200 | + |
| 201 | + it('should contain the voteimmunecheck command description', function () { |
| 202 | + expect(helpText).to.include('`voteimmunecheck`'); |
| 203 | + expect(helpText).to.include('Check vote immune status.'); |
| 204 | + }); |
| 205 | + |
| 206 | + it('should contain the vote command description with voteLimit placeholder', function () { |
| 207 | + expect(helpText).to.include('`vote [position]`'); |
| 208 | + expect(helpText).to.include('Move a track to the top. Needs *{{voteLimit}}* votes.'); |
| 209 | + }); |
| 210 | + |
| 211 | + it('should contain the votecheck command description', function () { |
| 212 | + expect(helpText).to.include('`votecheck`'); |
| 213 | + expect(helpText).to.include('Check the current vote counts.'); |
| 214 | + }); |
| 215 | + |
| 216 | + it('should contain the flushvote command description with flushVoteLimit and voteTimeLimitMinutes placeholders', function () { |
| 217 | + expect(helpText).to.include('`flushvote`'); |
| 218 | + expect(helpText).to.include('Vote to clear the entire queue. Needs *{{flushVoteLimit}}* votes within *{{voteTimeLimitMinutes}}* min.'); |
| 219 | + }); |
| 220 | +}); |
| 221 | + |
| 222 | +// ─── Handlebars placeholders (shared Slack + Discord rendering) ─────────────── |
| 223 | + |
| 224 | +describe('helpText.txt — Template placeholders for Slack and Discord are intact', function () { |
| 225 | + |
| 226 | + it('should contain the {{searchLimit}} placeholder', function () { |
| 227 | + expect(helpText).to.include('{{searchLimit}}'); |
| 228 | + }); |
| 229 | + |
| 230 | + it('should contain the {{gongLimit}} placeholder', function () { |
| 231 | + expect(helpText).to.include('{{gongLimit}}'); |
| 232 | + }); |
| 233 | + |
| 234 | + it('should contain the {{voteImmuneLimit}} placeholder', function () { |
| 235 | + expect(helpText).to.include('{{voteImmuneLimit}}'); |
| 236 | + }); |
| 237 | + |
| 238 | + it('should contain the {{voteLimit}} placeholder', function () { |
| 239 | + expect(helpText).to.include('{{voteLimit}}'); |
| 240 | + }); |
| 241 | + |
| 242 | + it('should contain the {{flushVoteLimit}} placeholder', function () { |
| 243 | + expect(helpText).to.include('{{flushVoteLimit}}'); |
| 244 | + }); |
| 245 | + |
| 246 | + it('should contain the {{voteTimeLimitMinutes}} placeholder', function () { |
| 247 | + expect(helpText).to.include('{{voteTimeLimitMinutes}}'); |
| 248 | + }); |
| 249 | +}); |
| 250 | + |
| 251 | +// ─── Footer / tip lines unchanged ──────────────────────────────────────────── |
| 252 | + |
| 253 | +describe('helpText.txt — Footer and tip lines are unchanged', function () { |
| 254 | + |
| 255 | + it('should contain the Spotify URI tip line', function () { |
| 256 | + expect(helpText).to.include( |
| 257 | + 'Tip: You can use Spotify URIs (spotify:track:...) OR paste Spotify links (https://open.spotify.com/...)' |
| 258 | + ); |
| 259 | + }); |
| 260 | + |
| 261 | + it('should contain the GitHub link in the footer', function () { |
| 262 | + expect(helpText).to.include('https://github.com/htilly/SlackONOS'); |
| 263 | + }); |
| 264 | + |
| 265 | + it('should contain the suggestions/bugs footer line', function () { |
| 266 | + expect(helpText).to.include('Suggestions or bugs?'); |
| 267 | + }); |
| 268 | +}); |
| 269 | + |
| 270 | +// ─── Structural / ordering checks ──────────────────────────────────────────── |
| 271 | + |
| 272 | +describe('helpText.txt — Section ordering is correct', function () { |
| 273 | + |
| 274 | + it('should have Music Commands before Info Commands', function () { |
| 275 | + const musicIdx = helpText.indexOf('*🎵 Music Commands:*'); |
| 276 | + const infoIdx = helpText.indexOf('*ℹ️ Info Commands:*'); |
| 277 | + expect(musicIdx).to.be.greaterThan(-1); |
| 278 | + expect(infoIdx).to.be.greaterThan(-1); |
| 279 | + expect(musicIdx).to.be.lessThan(infoIdx); |
| 280 | + }); |
| 281 | + |
| 282 | + it('should have Info Commands before Voting Commands', function () { |
| 283 | + const infoIdx = helpText.indexOf('*ℹ️ Info Commands:*'); |
| 284 | + const votingIdx = helpText.indexOf('*🗳️ Voting Commands:*'); |
| 285 | + expect(infoIdx).to.be.greaterThan(-1); |
| 286 | + expect(votingIdx).to.be.greaterThan(-1); |
| 287 | + expect(infoIdx).to.be.lessThan(votingIdx); |
| 288 | + }); |
| 289 | + |
| 290 | + it('should have Voting Commands before Feedback section', function () { |
| 291 | + const votingIdx = helpText.indexOf('*🗳️ Voting Commands:*'); |
| 292 | + const feedbackIdx = helpText.indexOf('*📝 Feedback:*'); |
| 293 | + expect(votingIdx).to.be.greaterThan(-1); |
| 294 | + expect(feedbackIdx).to.be.greaterThan(-1); |
| 295 | + expect(votingIdx).to.be.lessThan(feedbackIdx); |
| 296 | + }); |
| 297 | + |
| 298 | + it('should have the featurerequest entry after the Feedback section header and before the footer tip', function () { |
| 299 | + const feedbackIdx = helpText.indexOf('*📝 Feedback:*'); |
| 300 | + const featureRequestIdx = helpText.indexOf('featurerequest'); |
| 301 | + const tipIdx = helpText.indexOf('_Tip:'); |
| 302 | + expect(feedbackIdx).to.be.greaterThan(-1); |
| 303 | + expect(featureRequestIdx).to.be.greaterThan(feedbackIdx); |
| 304 | + expect(featureRequestIdx).to.be.lessThan(tipIdx); |
| 305 | + }); |
| 306 | +}); |
0 commit comments