Changeset 4909

Timestamp:

12/01/08 08:13:29 (1 month ago)

Author:

optilude

Message:

Check in work previously in patch

Files:

• estimationtoolsplugin/branches/optilude-change-line/estimationtools/burndownchart.py (modified) (6 diffs)
• estimationtoolsplugin/branches/optilude-change-line/estimationtools/tests/burndownchart.py (modified) (14 diffs)
• estimationtoolsplugin/branches/optilude-change-line/estimationtools/tests/workloadchart.py (modified) (2 diffs)
• estimationtoolsplugin/branches/optilude-change-line/estimationtools/utils.py (modified) (4 diffs)

estimationtoolsplugin/branches/optilude-change-line/estimationtools/burndownchart.py

@@ -2 +2 @@
-from datetime import datetime
-from datetime import timedelta
-, get_estimation_field,\
-
+
+
-from trac.core import TracError
-from trac.util.html import Markup
@@ -10 +10 @@
-import copy
-
-
+,aa8800
-
-class BurndownChart(WikiMacroBase):
@@ -28 +28 @@
-     * `color`: color specified as 6-letter string of hexadecimal values in the format `RRGGBB`.
-       Defaults to `ff9900`, a nice orange.
+     * `title`: the title of the graph. If omitted, defaults to the title of the first milestone given, if any.
+     * `change`: set to 1 to include a second line showing what the burndown would've looked like, had
+        there not been any scope change
+     * `interval_days`: the number of days between points on the x axis, defaulting to 1
-     
-    Examples:
@@ -37 +41 @@
-    """
-
+    initial_estimation_field = get_initial_estimation_field()
-    estimation_field = get_estimation_field()
-    closed_states = get_closed_states()
-    
-    def render_macro(self, req, name, content):
-
+
-        # prepare options
-        options, query_args = parse_options(self.env.get_db_cnx(), content, copy.copy(DEFAULT_OPTIONS))
@@ -52 +57 @@
-            options['enddate'] = options['startdate'] + timedelta(days=1)
-
+        change = options['change']
+
-        # calculate data
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-        # build html for google chart api
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-            "|1:|%s|%s" % (dates[0].month, dates[ - 1].month) + \
-            "|2:|%s|%s" % (dates[0].year, dates[ - 1].year)
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        weekends = []
-        saturday = None
@@ -84 +308 @@
-        if len(dates) > 0 and dates[ - 1].weekday() == 5:
-            weekends.append("R,f1f1f1,0,%s,1.0" % (Decimal(1) - halfday))
-
-
-
+
+
+
+
+
-            title = options['milestone'].split('|')[0]
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-    
-    def _round(self, decimal_):

estimationtoolsplugin/branches/optilude-change-line/estimationtools/tests/burndownchart.py

@@ -15 +15 @@
-        self.env = EnvironmentStub(default_data = True)
-        self.env.config.set('ticket-custom', 'hours_remaining', 'text')
+        self.env.config.set('ticket-custom', 'hours_initial', 'text')
-        self.env.config.set('estimation-tools', 'estimation_field', 'hours_remaining')
+        self.env.config.set('estimation-tools', 'initial_estimation_field', 'hours_initial')
-        self.req = Mock(href = Href('/'),
-                        abs_href = Href('http://www.example.com/'),
@@ -25 +27 @@
-        ticket['summary'] = 'Test Ticket'
-        ticket['hours_remaining'] = estimation
+        ticket['hours_initial'] = estimation
-        ticket['milestone'] = 'milestone1'
-        return ticket.insert()
@@ -34 +37 @@
-        for key in keys:
-            ticket['hours_remaining'] = history[key]
+            ticket.save_changes("me", "testing", datetime.combine(key, datetime.now(utc).timetz()))
+    
+    def _change_ticket_initial_estimations(self, id, history):
+        ticket = Ticket(self.env, id)
+        keys = history.keys()
+        keys.sort()
+        for key in keys:
+            ticket['hours_initial'] = history[key]
-            ticket.save_changes("me", "testing", datetime.combine(key, datetime.now(utc).timetz()))
-            
@@ -55 +66 @@
-        db = self.env.get_db_cnx()
-        options, query_args = parse_options(db, "milestone=milestone1, startdate=2008-02-20, enddate=2008-02-28", {})
-
-
+
+
+
-        self.assertEqual(xdata, ['0.00', '12.50', '25.00', '37.50', '50.00', '62.50', '75.00', '87.50', '100.00'])
-        self.assertEqual(ydata, ['0.00', '0.00', '0.00', '0.00', '0.00', '0.00', '0.00', '0.00', '0.00'])
@@ -71 +83 @@
-        day2 = day1 + timedelta(days=1)
-        day3 = day2 + timedelta(days=1)
-, 'closedstates': ['closed']
+
-        query_args = {'milestone': "milestone1"}
-        self._insert_ticket('10')
-
+, _
-        self.assertEqual(timetable, {day1: Decimal(10), day2: Decimal(10), day3: Decimal(10)})
-        
@@ -82 +94 @@
-        day2 = day1 + timedelta(days=1)
-        day3 = day2 + timedelta(days=1)
-, 'closedstates': ['closed']
+
-        self._insert_ticket('10')
-
+, _
-        self.assertEqual(timetable, {day1: Decimal(10), day2: Decimal(10), day3: Decimal(10)})
-        
@@ -92 +104 @@
-        day2 = day1 + timedelta(days=1)
-        day3 = day2 + timedelta(days=1)
-, 'closedstates': ['closed']
+
-        query_args = {'milestone': "milestone1"}
-        ticket1 = self._insert_ticket('10')
-        self._change_ticket_estimations(ticket1, {day2:'5', day3:'0'})
-     
-
+, _
-        self.assertEqual(timetable, {day1: Decimal(10), day2: Decimal(5), day3: Decimal(0)})
-        
@@ -105 +117 @@
-        day2 = day1 + timedelta(days=1)
-        day3 = day2 + timedelta(days=1)
-, 'closedstates': ['closed']
+
-        query_args = {'milestone': "milestone1"}
-        ticket1 = self._insert_ticket('10')
-        self._change_ticket_estimations(ticket1, {day2:'5'})
-        self._change_ticket_states(ticket1, {day3: 'closed'})
-
+, _
-        self.assertEqual(timetable, {day1: Decimal(10), day2: Decimal(5), day3: Decimal(0)})
-
@@ -118 +130 @@
-        day2 = day1 + timedelta(days=1)
-        day3 = day2 + timedelta(days=1)
-, 'closedstates': ['closed']
+
-        query_args = {'milestone': "milestone1"}
-        ticket1 = self._insert_ticket('10')
-        self._change_ticket_states(ticket1, {day2: 'closed'})
-        self._change_ticket_estimations(ticket1, {day3:'5'})
-
+, _
-        self.assertEqual(timetable, {day1: Decimal(10), day2: Decimal(0), day3: Decimal(0)})
-
@@ -132 +144 @@
-        day3 = day2 + timedelta(days=1)
-        day4 = day3 + timedelta(days=1)
-, 'closedstates': ['closed']
+
-        query_args = {'milestone': "milestone1"}
-        ticket1 = self._insert_ticket('10')
-        self._change_ticket_estimations(ticket1, {day3:'5'})
-        self._change_ticket_states(ticket1, {day2: 'closed', day4: 'new'})
-
+, _
-        self.assertEqual(timetable, {day1: Decimal(10), day2: Decimal(0), day3: Decimal(0), day4: Decimal(5)})
-        
@@ -145 +157 @@
-        day2 = day1 + timedelta(days=1)
-        day3 = day2 + timedelta(days=1)
-, 'closedstates': ['closed']
+
-        query_args = {'milestone': "milestone1"}
-        ticket1 = self._insert_ticket('10')
@@ -152 +164 @@
-        self._change_ticket_estimations(ticket2, {day2:'1', day3:'2'})
-     
-
+, _
-        self.assertEqual(timetable, {day1: Decimal(10), day2: Decimal(6), day3: Decimal(2)})
-
@@ -161 +173 @@
-        day3 = day2 + timedelta(days=1)
-        day4 = day3 + timedelta(days=1)
-3, 'startdate': day1, 'enddate': day3, 'closedstates': ['closed']
+4, 'startdate': day1, 'enddate': day3
-        query_args = {'milestone': "milestone1"}
-        ticket1 = self._insert_ticket('10')
-        self._change_ticket_estimations(ticket1, {day2:'5', day4:''})
-     
-
+, _
-        self.assertEqual(timetable, {day1: Decimal(10), day2: Decimal(5), day3: Decimal(5)})
-    
@@ -174 +186 @@
-        day2 = day1 + timedelta(days=1)
-        day3 = day2 + timedelta(days=1)
-, 'closedstates': ['closed']
+
-        query_args = {'milestone': "milestone1"}
-        ticket1 = self._insert_ticket('10')
-        self._change_ticket_estimations(ticket1, {day2: 'IGNOREME', day3:'5'})
-
+, _
-        self.assertEqual(timetable, {day1: Decimal(10), day2: Decimal(10), day3: Decimal(5)})
+        
+    def test_calculate_delta_no_new_or_changed(self):
+        chart = BurndownChart(self.env)
+        day1 = datetime.now(utc).date()
+        day2 = day1 + timedelta(days=1)
+        day3 = day2 + timedelta(days=1)
+        options = {'today': day3, 'startdate': day1, 'enddate': day3, 'change': True}
+        query_args = {'milestone': "milestone1"}
+        ticket1 = self._insert_ticket('10')
+        self._change_ticket_estimations(ticket1, {day2:'5', day3:''})
+        ticket2 = self._insert_ticket('0')
+        self._change_ticket_estimations(ticket2, {day2:'1', day3:'2'})
+     
+        timetable, delta = chart._calculate_timetable(options, query_args, self.req)
+        self.assertEqual(timetable, {day1: Decimal(10), day2: Decimal(6), day3: Decimal(2)})
+        self.assertEqual(delta, {day1: Decimal(0), day2: Decimal(0), day3: Decimal(0)})
+                
+    def test_calculate_delta_with_changed_estimates(self):
+        chart = BurndownChart(self.env)
+        day1 = datetime.now(utc).date()
+        day2 = day1 + timedelta(days=1)
+        day3 = day2 + timedelta(days=1)
+        options = {'today': day3, 'startdate': day1, 'enddate': day3, 'change': True}
+        query_args = {'milestone': "milestone1"}
+        ticket1 = self._insert_ticket('10')
+        ticket2 = self._insert_ticket('5')
+        self._change_ticket_initial_estimations(ticket1, {day2:'8'}) # -2
+        self._change_ticket_initial_estimations(ticket2, {day3:'8'}) # +3
+        import time; time.sleep(1) # Avoid time resolution problem
+        self._change_ticket_estimations(ticket2, {day2:'1', day3:'2'})
+     
+        timetable, delta = chart._calculate_timetable(options, query_args, self.req)
+        self.assertEqual(timetable, {day1: Decimal(15), day2: Decimal(11), day3: Decimal(12)})
+        self.assertEqual(delta, {day1: Decimal(0), day2: Decimal(-2), day3: Decimal(3)})
+        
+    def test_date_intervals(self):
+        chart = BurndownChart(self.env)
+        day1 = datetime.now(utc).date()
+        day2 = day1 + timedelta(days=1)
+        day3 = day2 + timedelta(days=1)
+        day4 = day3 + timedelta(days=1)
+        day5 = day4 + timedelta(days=1)
+        options = {'today': day5, 'startdate': day1, 'enddate': day5, 'interval_days': 2}
+        query_args = {'milestone': "milestone1"}
+        ticket1 = self._insert_ticket('10')
+        ticket2 = self._insert_ticket('5')
+        self._change_ticket_estimations(ticket2, {day3:'1', day4:'2', day5:'3'})
+
+        timetable, delta = chart._calculate_timetable(options, query_args, self.req)
+        
+        self.assertEqual(timetable, {day1: Decimal(15), day3: Decimal(11), day5: Decimal(13)})
+        self.assertEqual(delta, {day1: Decimal(0), day3: Decimal(0), day5: Decimal(0)})
+    
+    def test_date_intervals_always_includes_today(self):
+        chart = BurndownChart(self.env)
+        day1 = datetime.now(utc).date()
+        day2 = day1 + timedelta(days=1)
+        day3 = day2 + timedelta(days=1)
+        day4 = day3 + timedelta(days=1)
+        day5 = day4 + timedelta(days=1)
+        day6 = day4 + timedelta(days=1)
+        options = {'today': day5, 'startdate': day1, 'enddate': day5, 'interval_days': 2}
+        query_args = {'milestone': "milestone1"}
+        ticket1 = self._insert_ticket('10')
+        ticket2 = self._insert_ticket('5')
+        self._change_ticket_estimations(ticket2, {day3:'1', day4:'2', day5:'3',day6:'4'})
+
+        timetable, delta = chart._calculate_timetable(options, query_args, self.req)
+        
+        self.assertEqual(timetable, {day1: Decimal(15), day3: Decimal(11), day5: Decimal(13), day6: Decimal(14)})
+        self.assertEqual(delta, {day1: Decimal(0), day3: Decimal(0), day5: Decimal(0), day6: Decimal(0)})

estimationtoolsplugin/branches/optilude-change-line/estimationtools/tests/workloadchart.py

@@ -32 +32 @@
-        result = workload_chart.render_macro(self.req, "", "milestone=milestone1")
-        self.assertEqual(result, u'<img src="http://chart.apis.google.com/chart?chs=400x100&amp;'\
-0
+1
-                         'chl=A 10h|C 30h|B 20h&amp;chco=ff9900" alt=\'Workload Chart\' />')
-
@@ -44 +44 @@
-        result = workload_chart.render_macro(self.req, "", "milestone=milestone1")
-        self.assertEqual(result, u'<img src="http://chart.apis.google.com/chart?chs=400x100&amp;'\
-0
+1
-                         'chl=A 10h|C 30h|B 20h&amp;chco=ff9900" alt=\'Workload Chart\' />' )

estimationtoolsplugin/branches/optilude-change-line/estimationtools/utils.py

@@ -6 +6 @@
-from trac.ticket.query import Query
-
-
+, 'title', 'change', 'interval_days'
-
-def get_estimation_field():    
@@ -12 +12 @@
-        doc="""Defines what custom field should be used to calculate estimation charts.
-        Defaults to 'estimatedhours'""")
+
+def get_initial_estimation_field():    
+    return Option('estimation-tools', 'initial_estimation_field', '', 
+        doc="""When calculating project change, use this field instead of the one set for estimation_field.
+        Defaults to be the same as 'estimation_field'""")
-
-def get_closed_states():
@@ -62 +67 @@
-        options['today'] = datetime.now().date()
-    
+    if 'interval_days' in options:
+        try:
+            options['interval_days'] = int(options['interval_days'])
+        except (ValueError, TypeError):
+            options['interval_days'] = 1
+    else:
+        options['interval_days'] = 1
+        
+    if 'change' in options and options['change'].lower() not in ('false', '0'):
+        options['change'] = True
+    else:
+        options['change'] = False
+    
-    # all arguments that are no key should be treated as part of the query  
-    query_args = {}
@@ -70 +88 @@
-
-def execute_query(env, req, query_args):
-    # set maximum number of returned tickets to 0 to get all tickets at once
-    query_args['max'] = 0
-    query_string = '&'.join(['%s=%s' % item for item in query_args.iteritems()])
-    query = Query.from_string(env, query_string)