@beauraines/sprint-tracker 0.6.1

package/cmds/addOutcomes.js

@@ -0,0 +1,98 @@
+#!/usr/bin/env node
+
+const {homedir} = require('os');
+const { 	database: db	} = require('helpers')
+const { prompt,promptForInput } = require('../utils/input.js')
+const {readConfig} = require('../utils/readConfig.js')
+const display = require('../utils/display.js')
+const path = require('path');
+
+const command = 'addOutcome'
+const desc = 'Menu driven process to add outcomes to a sprint'
+const builder = {}
+
+const handler = async function () {
+	// TODO add migrations check or index function
+	const filename = 'sprintTracker.json'
+    const configFile = path.join(homedir(),filename)
+	const config = await readConfig(configFile)
+	const database = config.database
+
+	// list projects
+	
+	let statement = 'select * from projects;';
+
+	let projects = await db.query(database,statement)
+	
+	for (const project of projects) {
+        console.log(project.id, project.name)
+    }
+	
+	// Select the project
+	let project_id
+
+	let text = 'Enter the project id: '
+	while (!project_id) {
+		project_id = prompt(text) 
+	
+		// validate the response
+		if (!projects.find(x => (x.id == project_id))) {
+			console.error('Invalid project id')
+			project_id = null
+		}
+	}
+
+
+	console.log(project_id)
+
+    // Add new sprint
+
+    let sprints = await db.query(database,`select id, sprint_name AS name from sprints where project_id = ${project_id};`)
+	
+	// FIXME - sprint_name isn't being displayed because the function is looking for name
+	console.log('If your sprint is not displayed, you will have to manually add it.')
+	let sprintId = promptForInput(sprints,'Enter the sprint id: ')
+    
+	// enter outcomes
+	let sprintOutcomes = []
+    let outcomes = await db.query(database,'select * from outcomes;')
+	for (const outcome of outcomes) {
+        // TODO Fix output formatting
+        console.log(outcome.id, outcome.name, outcome.description)
+		let issue_count = prompt('Enter the number of stories or a blank line to skip: ')
+		if (issue_count ==  '' ) {
+			continue
+		}
+		let story_points = prompt('Enter the number of story points: ')
+		let notes = prompt('Enter any notes: ')
+
+		sprintOutcomes.push({
+			sprint_id: sprintId,
+			sprint_name: sprints.filter(x => x.id == sprintId)[0].name,
+			outcome_id: outcome.id,
+			outcome_name: outcome.name,
+			outcome_description: outcome.description,
+			issue_count,
+			story_points,
+			notes
+		})
+    }  
+	// validate sprint_outcomes
+	display.sprintOutcomes(sprintOutcomes)
+	
+	// Save outcomes to DB
+	// Remove properties not in the table
+	for (const outcome of sprintOutcomes) {
+		delete outcome.sprint_name
+		delete outcome.outcome_name
+		delete outcome.outcome_description
+	}
+	let result = await db.insert(database,'sprint_outcomes',sprintOutcomes,['sprint_id','outcome_id'])
+}
+
+module.exports = {
+	command,
+	desc,
+	builder,
+	handler
+}

package/cmds/addProject.js

@@ -0,0 +1,53 @@
+#!/usr/bin/env node
+
+const {homedir} = require('os');
+const { 	database: db	} = require('helpers')
+const { prompt } = require('../utils/input.js')
+const {readConfig} = require('../utils/readConfig.js')
+const display = require('../utils/display.js')
+const path = require('path');
+
+const command = 'addProject'
+const desc = 'Prompts to add a new project to the database'
+const builder = {}
+
+const handler = async function () {
+	
+	const filename = 'sprintTracker.json'
+    const configFile = path.join(homedir(),filename)
+	const config = await readConfig(configFile)
+	const database = config.database
+
+    // Get new project information from user
+    let name = prompt('Enter the Project Name: ')
+    let pm_name = prompt('Enter the PM Name: ')
+    let pm_email = prompt('Enter the PM Email: ')
+    let client = prompt('Enter the Client: ')
+    let project_number = prompt('Enter the Project Number: ')
+    let start_date = prompt('Enter the start date (YYYY-MM-DD): ')
+    let end_date = prompt('Enter the end date (YYYY-MM-DD): ')
+
+
+    let project = {
+        name,
+        pm_name,
+        pm_email,
+        client,
+        project_number,
+        start_date,
+        end_date
+    }
+	
+	// Save project to DB
+	let result = await db.insert(database,'projects',[project])
+
+    project.id = result[0].lastID
+	display.project(project)
+}
+
+module.exports = {
+	command,
+	desc,
+	builder,
+	handler
+}

package/cmds/addSprint.js

@@ -0,0 +1,117 @@
+#!/usr/bin/env node
+
+const {homedir} = require('os');
+const { 	database: db	} = require('helpers')
+const { prompt } = require('../utils/input.js')
+const {readConfig} = require('../utils/readConfig.js')
+const display = require('../utils/display.js')
+const path = require('path');
+
+const command = 'addSprint'
+const desc = 'Prompts to add a new sprint to an existing project'
+const builder = {}
+
+const handler = async function () {
+	
+	const filename = 'sprintTracker.json'
+	const configFile = path.join(homedir(),filename)
+	const config = await readConfig(configFile)
+	const database = config.database
+
+	// list projects
+	
+	let statement = 'select * from projects;';
+
+	let projects = await db.query(database,statement)
+	
+	for (const project of projects) {
+        console.log(project.id, project.name)
+    }
+	
+	// Select the project
+	let project_id
+
+	let text = 'Enter the project id: '
+	while (!project_id) {
+		project_id = prompt(text) 
+	
+		// validate the response
+		if (!projects.find(x => (x.id == project_id))) {
+			console.error('Invalid project id')
+			project_id = null
+		}
+	}
+
+
+	console.log(project_id)
+
+    // Get new sprint information from user
+
+    let sprint_name = prompt('Enter the sprint name: ')
+    let start_date = prompt('Enter the sprint start date: ')
+    let end_date = prompt('Enter the sprint end date: ')
+    let non_working_days = prompt('Enter the number of non working days: ')
+    let developers = prompt('Enter the number of developers assigned: ')
+    let developer_pto_days = prompt('Enter the total number of developer PTO days: ')
+
+    let sprint = {
+        sprint_name,
+        project_id,
+        start_date,
+        end_date,
+        non_working_days,
+        developers,
+        developer_pto_days
+    }
+	
+	// Save outcomes to DB
+	let result = await db.insert(database,'sprints',[sprint])
+	let sprintId = result[0].lastID
+
+	// Prompt for commitment
+	let sprintOutcomes = []
+    let outcomes = await db.query(database,`select * from outcomes where name = 'Commitment';`)
+	for (const outcome of outcomes) {
+        // TODO Fix output formatting
+        console.log(outcome.id, outcome.name, outcome.description)
+		let issue_count = prompt('Enter the number of stories or a blank line to skip: ')
+		if (issue_count ==  '' ) {
+			continue
+		}
+		let story_points = prompt('Enter the number of story points: ')
+		let notes = prompt('Enter any notes: ')
+
+		sprintOutcomes.push({
+			sprint_id: sprintId,
+			sprint_name,
+			outcome_id: outcome.id,
+			outcome_name: outcome.name,
+			outcome_description: outcome.description,
+			issue_count,
+			story_points,
+			notes
+		})
+    }  
+	// validate sprint_outcomes
+	
+	display.sprintOutcomes(sprintOutcomes)
+	
+	if (sprintOutcomes.length != 0) {
+		// Save outcomes to DB
+		// Remove properties not in the table
+		for (const outcome of sprintOutcomes) {
+			delete outcome.sprint_name
+			delete outcome.outcome_name
+			delete outcome.outcome_description
+		}
+		result = await db.insert(database,'sprint_outcomes',sprintOutcomes,['sprint_id','outcome_id'])
+	}
+	
+}
+
+module.exports = {
+	command,
+	desc,
+	builder,
+	handler
+}

package/cmds/config.js

@@ -0,0 +1,33 @@
+const { homedir } = require('os');
+const { createConfig } = require('../utils/readConfig.js')
+const { helpers } = require('helpers')
+const path = require('path');
+
+
+const command = 'config'
+const desc = 'Creates a config file, prompting for required inputs'
+const builder = {}
+
+const handler = async function () {
+
+    const filename = 'sprintTracker.json'
+    const configFile = path.join(homedir(), filename)
+
+    if (helpers.fileExists(configFile)) {
+        console.error(`Aborting. Existing configuration file ${configFile} found to not overwrite your values.`)
+        process.exit(1)
+    }
+
+    const configProps = ['database']
+    await createConfig(configFile, configProps)
+    console.log(`Created ${configFile}`)
+    console.log(`Please edit the file and update the ${configProps} value(s)`)
+
+}
+
+module.exports = {
+    command,
+    desc,
+    builder,
+    handler
+}

package/cmds/getSprintDetails.js

@@ -0,0 +1,86 @@
+#!/usr/bin/env node
+
+const {homedir} = require('os');
+const { 	database: db	} = require('helpers')
+const { prompt,promptForInput } = require('../utils/input.js')
+const {readConfig} = require('../utils/readConfig.js')
+const display = require('../utils/display.js')
+const path = require('path');
+
+const command = 'getSprint'
+const desc = 'Gets sprint details'
+const builder = {}
+const handler = async function () {
+
+	const filename = 'sprintTracker.json'
+    const configFile = path.join(homedir(),filename)
+	const config = await readConfig(configFile)
+	const database = config.database
+
+	// list projects
+	
+	let statement = 'select * from projects;';
+
+	let projects = await db.query(database,statement)
+	
+	for (const project of projects) {
+        console.log(project.id, project.name)
+    }
+	
+	// Select the project
+	let project_id
+
+	let text = 'Enter the project id: '
+	while (!project_id) {
+		project_id = prompt(text) 
+	
+		// validate the response
+		if (!projects.find(x => (x.id == project_id))) {
+			console.error('Invalid project id')
+			project_id = null
+		}
+	}
+
+
+	let sprints = await db.query(database,`select id, sprint_name AS name from sprints where project_id = ${project_id};`)
+	
+	// FIXME - sprint_name isn't being displayed because the function is looking for name
+	console.log('If your sprint is not displayed, you will have to manually add it.')
+	let sprintId = promptForInput(sprints,'Enter the sprint id: ')
+
+	statement = `select
+    p.name,
+    s.sprint_name,
+    s.start_date,
+    s.end_date,
+    o.name AS outcome_name,
+    so.issue_count,
+    so.story_points,
+    so.notes,
+    o.description
+
+from
+    sprint_outcomes so
+    JOIN sprints s on s.id = so.sprint_id
+    JOIN outcomes o on o.id = so.outcome_id
+    JOIN projects p on p.id = s.project_id
+where
+--    p.id = 4 
+--    and sprint_name = 'ACDC 15'
+    p.id = ${project_id}
+	and s.id = ${sprintId}`
+    
+	let sprintDetails = await db.query(database,statement)
+	// console.log(sprintDetails)
+	display.sprintDetails(sprintDetails)
+
+	
+}
+
+
+module.exports = {
+	command,
+	desc,
+	builder,
+	handler
+}

package/cmds/visualizations.js

@@ -0,0 +1,116 @@
+#!/usr/bin/env node
+
+const { AsyncParser } = require('@json2csv/node')
+const {homedir, tmpdir} = require('os');
+const { 	database: db	} = require('helpers')
+const { prompt } = require('../utils/input.js')
+const {readConfig} =  require('helpers').config
+const exec = require('child_process').exec;
+const fs = require('fs');
+const path = require('path');
+const process = require('process');
+
+const command = 'visualizations'
+const desc = 'Creates Feature Team visualizations with R. Must have docker, rstudio-tidyverse container and more installed'
+const builder = {}
+
+const handler = async function () {
+    // Get Data from Database and write to file
+    console.log('Getting data')
+
+	const filename = 'sprintTracker.json'
+	const config = await readConfig(filename)
+	const database = config.database
+
+	// list projects
+	
+	let statement = 'select * from projects;';
+
+	let projects = await db.query(database,statement)
+	
+	for (const project of projects) {
+        console.log(project.id, project.name)
+    }
+	
+	// Select the project
+	let project_id
+
+	let text = 'Enter the project id: '
+	while (!project_id) {
+		project_id = prompt(text) 
+	
+		// validate the response
+		if (!projects.find(x => (x.id == project_id))) {
+			console.error('Invalid project id')
+			project_id = null
+		}
+	}
+
+    let query = `
+    SELECT 
+        p.name project_name,
+        s.id sprint_id,
+        s.sprint_name,
+        s.end_date,
+        case
+            when o.name = 'Commitment' then 'A-Commitment'
+            when o.name = 'Delivered' then 'B-Delivered'
+            else o.name
+        end outcome,
+        ifnull(so.story_points, so.issue_count) AS story_points -- accounts for unpointed bug stories
+    
+    from projects p
+    
+    JOIN sprints s on s.project_id = p.id
+    JOIN sprint_outcomes so on so.sprint_id = s.id
+    JOIN outcomes o on o.id = so.outcome_id
+    
+    WHERE
+      p.id = ${project_id};
+    `
+
+	let outcomes = await db.query(database,query)
+
+    // Convert JSON to CSV
+    const opts = {};
+    const transformOpts = {};
+    const asyncOpts = {};
+    const parser = new AsyncParser(opts, transformOpts, asyncOpts);
+    
+    const csv = await parser.parse(outcomes).promise();
+
+    // Write to file
+    
+
+    const outputFile = path.join(tmpdir(),'outcomes.csv');
+    try {
+        fs.writeFileSync(outputFile, csv);
+        // file written successfully
+        console.log(`Data written to ${outputFile}`)
+    } catch (err) {
+        console.error(err);
+        process.exit(1)
+    }
+
+
+    console.log('Making visualizations')
+    // Run docker command
+    let PROJECT_DIR=path.join(homedir(),'projects')
+    let IMAGE='rocker/tidyverse'
+    const cmd = `docker run -t --rm -v ${PROJECT_DIR}:/home/rstudio/projects/ -v ${tmpdir()}:/tmp ${IMAGE} su -c 'Rscript /home/rstudio/projects/sprint-tracker/R/sprintOutcomesCli.R' rstudio`
+    exec(cmd, function(err, stdout, stderr) {
+    if (err) {
+        console.log(stderr);
+        console.log(err.message)
+        process.exit(err.code)
+    }
+    console.log(stdout);
+    });
+}
+
+module.exports = {
+	command,
+	desc,
+	builder,
+	handler
+}

package/docker-compose.yml

@@ -0,0 +1,11 @@
+services:
+  rstudio:
+    image: rocker/tidyverse
+    ports: 
+      - 8888:8787
+    volumes:
+      - ~/projects:/home/rstudio/projects
+      - ~/BurnDownStatus.db:/home/rstudio/BurnDownStatus.db
+    container_name: rstudio-server-sprint-tracker
+    environment:
+      PASSWORD: password

package/migrations/20230222011333-create-health-table.sql

@@ -0,0 +1,10 @@
+CREATE TABLE IF NOT EXISTS  health (
+    id                INTEGER PRIMARY KEY AUTOINCREMENT,
+    project           STRING  NOT NULL,
+    date              DATE    NOT NULL,
+    bug_count         INTEGER DEFAULT (0),
+    unestimated_count INTEGER DEFAULT (0),
+    blocked_count     INTEGER DEFAULT (0),
+    open_count        INTEGER DEFAULT (0),
+    total_count       INTEGER DEFAULT (0) 
+);

package/migrations/20230222011334-outcomes.sql

@@ -0,0 +1,42 @@
+CREATE TABLE IF NOT EXISTS  outcomes (
+    id          INTEGER PRIMARY KEY,
+    name        STRING  NOT NULL,
+    description TEXT    NOT NULL
+);
+
+CREATE TABLE IF NOT EXISTS  projects (
+    id             INTEGER PRIMARY KEY AUTOINCREMENT,
+    name           STRING,
+    pm_name        STRING,
+    pm_email       STRING,
+    client         STRING,
+    project_number STRING,
+    start_date     DATE,
+    end_date       DATE
+);
+
+
+CREATE TABLE IF NOT EXISTS  sprint_outcomes (
+    id           INTEGER PRIMARY KEY AUTOINCREMENT,
+    sprint_id    INTEGER REFERENCES sprints (id) ON DELETE CASCADE
+                                                 ON UPDATE CASCADE,
+    outcome_id   INTEGER REFERENCES outcomes (id) ON DELETE SET DEFAULT
+                                                  ON UPDATE RESTRICT,
+    issue_count  INTEGER DEFAULT (0),
+    story_points INTEGER DEFAULT (0),
+    notes        TEXT
+);
+
+CREATE TABLE IF NOT EXISTS  sprints (
+    id                 INTEGER PRIMARY KEY AUTOINCREMENT,
+    sprint_name        STRING,
+    project_id         INTEGER REFERENCES projects (id) ON DELETE CASCADE
+                                                        ON UPDATE CASCADE,
+    start_date         DATE,
+    end_date           DATE,
+    commited_points    INTEGER DEFAULT (0),
+    committed_stories  INTEGER DEFAULT (0),
+    non_working_days   INTEGER DEFAULT (0),
+    developers         INTEGER DEFAULT (1),
+    developer_pto_days INTEGER DEFAULT (0) 
+);

package/migrations/20231206093700-seed-outcomes-table.sql

@@ -0,0 +1,9 @@
+INSERT into OUTCOMES (name,description) 
+VALUES 
+("Commitment","Initial sprint commitment"),
+("Delivered","Work completed this sprint"),
+("Unplanned - Story","All unplanned work brought into the sprint, whether completed or not"),
+("Unplanned - Bug","Unplanned work without a pre-existing story that was deemed critical enough to add to the sprint"),
+("Descoped","Committed work, removed from the sprint"),
+("Carryover","Incomplete, started or unstarted, work from this sprint, assumed that it will carryover to the next sprint"),
+("Carryover - External","Work that was carried over due to blockers external to the scrum team. Use of this is optional, as an agile team should be fully self-sufficient.");

package/migrations.js

@@ -0,0 +1,20 @@
+const sqlite3 = require('sqlite3').verbose();
+let {CommandsRunner, SQLite3Driver} = require('node-db-migration');
+const {homedir} = require('os');
+const {readConfig} = require('./utils/readConfig.js')
+const path = require('path');
+
+const main = async () => {
+    const filename = 'sprintTracker.json'
+    const configFile = path.join(homedir(),filename)
+    const config = await readConfig(configFile)
+    const database = config.database
+    let db = new sqlite3.Database(database);
+    let migrations = new CommandsRunner({
+        driver: new SQLite3Driver(db),
+        directoryWithScripts: __dirname + '/migrations',
+    });
+    migrations.run(process.argv[2])
+}
+
+main()

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@beauraines/sprint-tracker",
+  "version": "0.6.1",
+  "description": "Database and R visualizations to track sprint performance",
+  "main": "cli.js",
+  "bin": {
+    "sprint-tracker": "cli.js"
+  },
+  "scripts": {
+    "test": "jest",
+    "addOutcomes": "node src/addOutcomes.js",
+    "addSprint": "node src/addSprint.js",
+    "getSprintDetails": "node src/getSprintDetails.js",
+    "generateSprintOutcomePlot": "sh scripts/generateSprintOutcomePlot.sh",
+    "database:init": "node migrations.js init",
+    "database:migrate": "node migrations.js migrate",
+    "database:upgrade": "node migrations.js migrate",
+    "should-release": "should-release",
+    "release": "standard-version",
+    "lint": "eslint '*/**.js'",
+    "lint:fix": "eslint '*/**.js' --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@bitbucket.org/beauraines/sprint-tracker.git"
+  },
+  "author": "Beau Raines",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://bitbucket.org/beauraines/sprint-tracker/issues"
+  },
+  "homepage": "https://bitbucket.org/beauraines/sprint-tracker#readme",
+  "devDependencies": {
+    "eslint": "^8.42.0",
+    "eslint-plugin-jest": "^27.2.1",
+    "jest": "^29.3.1"
+  },
+  "dependencies": {
+    "@json2csv/node": "^7.0.1",
+    "cli-table3": "^0.6.3",
+    "helpers": "npm:@beauraines/node-helpers@^2.4.0",
+    "node-db-migration": "^1.4.0",
+    "prompt-sync": "^4.2.0",
+    "should-release": "^1.2.0",
+    "sqlite": "^4.1.2",
+    "sqlite3": "^5.1.2",
+    "standard-version": "^9.5.0",
+    "yargs": "^17.7.1"
+  }
+}

package/scripts/generateBacklogByTeam.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+if ! docker info > /dev/null 2>&1; then
+  echo "This script uses docker, and it isn't running - please start docker and try again!"
+  exit 1
+fi
+
+
+QUERY_ID=b18a81c9-3e3a-4dc6-87ef-140caf5bcb6a
+
+az boards query  --organization https://dev.azure.com/teamsi --id ${QUERY_ID} | 
+    jq -r '[.[]| {team:.fields."System.AreaPath",type:.fields."System.WorkItemType",id,estimate: .fields."Microsoft.VSTS.Scheduling.StoryPoints" }]' | 
+    json2csv -o ~/projects/backlog.csv
+
+
+# PROJECT_DIR must have trailing slash
+PROJECT_DIR=/Users/beauraines/projects/
+IMAGE=rocker/tidyverse
+
+docker run -it --rm -v ${PROJECT_DIR}:/home/rstudio/projects/ ${IMAGE} su -c 'Rscript /home/rstudio/projects/sprint-tracker/R/backlogByTeam.R 2>/dev/null' rstudio

package/scripts/generateBacklogHealth.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+if ! docker info > /dev/null 2>&1; then
+  echo "This script uses docker, and it isn't running - please start docker and try again!"
+  exit 1
+fi
+
+# PROJECT_DIR must have trailing slash
+PROJECT_DIR=/Users/beauraines/projects/
+IMAGE=rocker/tidyverse
+
+docker run -it --rm -v ${PROJECT_DIR}:/home/rstudio/projects/ ${IMAGE} su -c 'Rscript /home/rstudio/projects/sprint-tracker/R/backlogHealth.R 2>/dev/null' rstudio