taskjuggler 0.0.11 → 0.1.0

data/manual/The_TaskJuggler_Syntax

@@ -115,3 +115,9 @@ impact on the expansion of the macro.
 * ''''today'''' Identical to ''''now'''' but formatted according to
 the [[timeformat]] setting of the current context.
 
+=== Environment Variable Expansions ===
+
+By using the $(VAR) syntax, you can insert the value of the
+environment variable name VAR. The name of the variable must consists
+only of uppercase ASCII letters, underscore or decimal digits.
+

data/prj_cfg.rb

@@ -45,7 +45,6 @@ RAKEFILE        = 'Rakefile'
 PRJ_FILE        = 'prj_cfg.rb'
 GEM_SPEC_FILE   = 'gem_spec.rb'
 DATA_FILES      = FileList["benchmarks/**/*", "examples/**/*", "manual/*", "test/all.rb", "test/MessageChecker.rb", "test/TestSuite/**/*", "spec/**/*", "data/**/*"]
-DEPENDENCIES    = { 'mail' => '= 2.1.3',
-                    'open4' => '1.0.1' }
+DEPENDENCIES    = { 'mail' => '2.2.15' }
 DEVEL_DEPENDENCIES = { 'rcov' => '0.9.9',
-                       'rspec' => '2.3.0' }
+                       'rspec' => '2.5.0' }

data/spec/StatusSheets_spec.rb

@@ -0,0 +1,314 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = StatusSheets_spec.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of version 2 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+
+require 'rubygems'
+require 'fileutils'
+require 'support/DaemonControl'
+require 'taskjuggler/apps/Tj3SsSender'
+require 'taskjuggler/apps/Tj3SsReceiver'
+
+class TaskJuggler
+
+  class StatusSheetTest
+  end
+
+  describe StatusSheetTest do
+
+    include DaemonControl
+    include FileUtils
+
+    before(:all) do
+      @beforeExecuted = true
+      # Make sure we run in the same directory as the spec file.
+      @pwd = pwd
+      cd(File.dirname(__FILE__))
+      ENV['TASKJUGGLER_DATA_PATH'] = "../"
+
+      cleanup
+      startDaemon(<<'EOT'
+  smtpServer: example.com
+_statussheets:
+  projectId: sstest
+  senderEmail: foo@example.com
+  _sender:
+    hideResource: '~(isleaf() & manager)'
+EOT
+                 )
+      prj = <<'EOT'
+project sstest "Time Sheet Test" 2011-03-14 +2m {
+  trackingscenario plan
+  now ${projectstart}
+}
+
+flags manager, important, late
+
+resource "Team" {
+  resource boss "Boss" {
+    email "boss@example.com"
+    flags manager
+  }
+  resource r1 "R1" {
+    email "r1@example.com"
+  }
+  resource r2 "R2" {
+    email "r2@example.com"
+  }
+}
+task t1 "T1" {
+  effort 2.5d
+  allocate r1
+  responsible boss
+}
+task t2 "T2" {
+  depends !t1
+  effort 2.5d
+  allocate r1
+  responsible boss
+}
+task t3 "T3" {
+  effort 10d
+  allocate r2
+  responsible boss
+}
+timesheet r1 2011-03-14-00:00-+0000 - 2011-03-21-00:00-+0000 {
+  task t1 {
+    work 30.0%
+    remaining 2.0d
+    status red "More work" {
+      flags important, late
+      details -8<-
+      This is more work than expected.
+      ->8-
+    }
+  }
+  task t2 {
+    work 50.0%
+    remaining 0.0d
+    status green "All work done!"
+  }
+
+  newtask t4 "A new job" {
+    work 20%
+    remaining 1.0d
+    status green "May be a good idea" {
+      summary -8<-
+      I thought this might be useful work.
+      ->8-
+    }
+  }
+}
+timesheet r2 2011-03-14-00:00-+0000 - 2011-03-21-00:00-+0000 {
+  # Task: T3
+  task t3 {
+    work 100.0%
+    remaining 5.0d
+    status green "What a job!"
+  }
+
+  status yellow "I'm not feeling good!" {
+    flags important
+    summary -8<-
+    We all live on a yellow submarine!
+    ->8-
+  }
+}
+EOT
+      res = stdIoWrapper(prj) do
+        Tj3Client.new.main(%w( --unsafe --silent add . ))
+      end
+      unless res.stdErr =~ /Project sstest loaded/
+        raise "Project not loaded: #{res.stdErr}"
+      end
+      raise "Can't load project: #{res.stdErr}" unless res.returnValue == 0
+
+      res = stdIoWrapper do
+        Tj3SsSender.new.main(%w( --dryrun --silent -e 2011-03-23 ))
+      end
+      @sss_mails = collectMails(res.stdOut)
+      raise " Status sheet generation failed" unless res.returnValue == 0
+
+      @sheet = <<'EOT'
+# --------8<--------8<--------
+statussheet boss 2011-03-16-00:00-+0000 - 2011-03-23-00:00-+0000 {
+
+  # Task: T1
+  task t1 {
+    status green "No More work" {
+      # Date: 2011-03-21-00:00-+0000
+      # Work: 30% (50%)    Remaining: 2.0d (0.0d)
+      author r1
+      flags late
+      details -8<-
+      This is job is a breeze.
+      ->8-
+    }
+  }
+
+  # Task: T2
+  task t2 {
+    # status green "All work done!" {
+    #   # Date: 2011-03-21-00:00-+0000
+    #   # Work: 50%    Remaining: 0.0d
+    #   author r1
+    # }
+  }
+
+  # Task: T3
+  task t3 {
+    status green "What a nice job!" {
+      # Date: 2011-03-21-00:00-+0000
+      # Work: 100%    Remaining: 5.0d (0.0d)
+      author r2
+    }
+  }
+
+}
+# -------->8-------->8--------
+EOT
+      mailBody = @sheet.unix2dos.to_base64
+      mail = Mail.new do
+        subject "Status sheet"
+        content_type [ 'text', 'plain', { 'charset' => 'UTF-8' } ]
+        content_transfer_encoding 'base64'
+        body mailBody
+      end
+      mail.to = 'taskjuggler@example.com'
+      mail.from 'boss@example.com'
+      res = stdIoWrapper(mail.to_s) do
+        Tj3SsReceiver.new.main(%w( --dryrun --silent . ))
+      end
+      unless res.returnValue == 0
+        raise " Status sheet reception failed: #{res.stdErr}"
+      end
+      @ssr_mails = collectMails(res.stdOut)
+    end
+
+    after(:all) do
+      stopDaemon
+      cleanup
+      cd(@pwd)
+    end
+
+    it 'is just a dummy' do
+    end
+
+    describe StatusSheetSender do
+
+      it 'should have generated 1 mail' do
+        @sss_mails.length.should == 1
+      end
+
+      it 'should have email sender foo@example.com' do
+        @sss_mails.each do |mail|
+          mail.from[0].should == 'foo@example.com'
+        end
+      end
+
+      it 'should have proper email receivers' do
+        @sss_mails[0].to[0].should == 'boss@example.com'
+      end
+
+      it 'should generate properly dated headers' do
+        countLines(@sss_mails[0].parts[0].decoded,
+                   'statussheet boss 2011-03-16-00:00-+0000 - ' +
+                   '2011-03-23-00:00-+0000').should == 1
+      end
+
+      it 'should have matching status sheets in body and attachment' do
+        @sss_mails.each do |mail|
+          bodySheet = extractStatusSheet(mail.parts[0].decoded)
+          attachedSheet = extractStatusSheet(mail.part[1].decoded)
+          bodySheet.should == attachedSheet
+        end
+      end
+
+    end
+
+    describe StatusSheetReceiver do
+
+      it 'should have generated 1 mails' do
+        @ssr_mails.length.should == 1
+      end
+
+      it 'should have email sender foo@example.com' do
+        @ssr_mails.each do |mail|
+          mail.from[0].should == 'foo@example.com'
+        end
+      end
+
+      it 'should have email receivers boss@example.com' do
+        @ssr_mails[0].to[0].should == 'boss@example.com'
+      end
+
+      it 'should have stored status sheet' do
+        @sheet.should == File.read('StatusSheets/2011-03-23/boss_2011-03-23.tji')
+      end
+
+    end
+
+    private
+
+    def countLines(text, pattern)
+      c = 0
+      if pattern.is_a?(Regexp)
+        text.each_line do |line|
+          c += 1 if line =~ pattern
+        end
+      else
+        text.each_line do |line|
+          c += 1 if line.include?(pattern)
+        end
+      end
+      c
+    end
+
+    def extractStatusSheet(lines)
+      sheet = nil
+      lines.each_line do |line|
+        if line =~ /^# --------8<--------8<--------/
+          sheet = ""
+        elsif line =~ /^# -------->8-------->8--------/
+          raise 'Found end marker, but no start marker' unless sheet
+          return sheet
+        elsif sheet
+          sheet += line
+        end
+      end
+      raise "No end marker found"
+    end
+
+    def collectMails(lines)
+      mails = []
+      mailLines = nil
+      lines.each_line do |line|
+        if line =~ /^-- Email Start ---/
+          mailLines = ""
+        elsif line =~ /^-- Email End ---/
+          raise 'Found end marker, but no start marker' unless mailLines
+          mails << Mail.read_from_string(mailLines)
+          mailLines =  nil
+        elsif mailLines
+          mailLines += line
+        end
+      end
+      mails
+    end
+
+    def cleanup
+      rm_rf %w( StatusSheetTemplates StatusSheets statussheets.log tj3.log tj3ss_sender.log tj3ss_receiver.log tj3ts_summary.log )
+    end
+
+  end
+
+end
+

data/spec/TimeSheets_spec.rb

@@ -15,10 +15,12 @@ require 'rubygems'
 require 'fileutils'
 require 'support/DaemonControl'
 require 'taskjuggler/apps/Tj3TsSender'
+require 'taskjuggler/apps/Tj3TsReceiver'
+require 'taskjuggler/apps/Tj3TsSummary'
 
 class TaskJuggler
 
-  describe TimeSheetSender do
+  describe TimeSheets do
 
     include DaemonControl
     include FileUtils
@@ -27,6 +29,7 @@ class TaskJuggler
       # Make sure we run in the same directory as the spec file.
       @pwd = pwd
       cd(File.dirname(__FILE__))
+      ENV['TASKJUGGLER_DATA_PATH'] = "../"
 
       cleanup
       startDaemon(<<'EOT'
@@ -45,7 +48,13 @@ _timesheets:
 EOT
                  )
       prj = <<'EOT'
-project tstest "Time Sheet Test" 2011-03-14 +2m
+project tstest "Time Sheet Test" 2011-03-14 +2m {
+  trackingscenario plan
+  now ${projectstart}
+}
+
+flags important, late
+
 resource "Team" {
   resource r1 "R1" {
     email "r1@example.com"
@@ -76,10 +85,94 @@ EOT
       end
       raise "Can't load project" unless res.returnValue == 0
 
-      @res = stdIoWrapper do
+      res = stdIoWrapper do
         Tj3TsSender.new.main(%w( --dryrun --silent -e 2011-03-21 ))
       end
-      raise "Timesheet generation failed" unless @res.returnValue == 0
+      @tss_mails = collectMails(res.stdOut)
+      raise "Timesheet generation failed" unless res.returnValue == 0
+
+      @sheet1 = <<'EOT'
+# --------8<--------8<--------
+timesheet r1 2011-03-14-00:00-+0000 - 2011-03-21-00:00-+0000 {
+  task t1 {
+    work 30.0%
+    remaining 2.0d
+    status red "More work" {
+      flags important, late
+      details -8<-
+      This is more work than expected.
+      ->8-
+    }
+  }
+  task t2 {
+    work 50.0%
+    remaining 0.0d
+    status green "All work done!"
+  }
+
+  newtask t4 "A new job" {
+    work 20%
+    remaining 1.0d
+    status green "May be a good idea" {
+      summary -8<-
+      I thought this might be useful work.
+      ->8-
+    }
+  }
+}
+# -------->8-------->8--------
+EOT
+      @sheet2 = <<'EOT'
+# --------8<--------8<--------
+timesheet r2 2011-03-14-00:00-+0000 - 2011-03-21-00:00-+0000 {
+  # Task: T3
+  task t3 {
+    work 100.0%
+    remaining 5.0d
+    status green "What a job!"
+  }
+
+  status yellow "I'm not feeling good!" {
+    summary -8<-
+    We all live on a yellow submarine!
+    ->8-
+  }
+}
+# -------->8-------->8--------
+EOT
+      @tsr_mails = []
+      [ @sheet1, @sheet2 ].each do |sheet|
+        mail = Mail.new do
+          subject "Timesheet"
+          content_type [ 'text', 'plain', { 'charset' => 'UTF-8' } ]
+          content_transfer_encoding 'base64'
+          body sheet.to_base64
+        end
+        mail.to = 'taskjuggler@example.com'
+        mail.from 'r@example.com'
+        res = stdIoWrapper(mail.to_s) do
+          Tj3TsReceiver.new.main(%w( --dryrun --silent ))
+        end
+        @tsr_mails += collectMails(res.stdOut)
+        unless res.returnValue == 0
+          raise "Timesheet processing failed: #{res.stdErr}"
+        end
+      end
+
+      res = stdIoWrapper(prj) do
+        Tj3Client.new.main(%w( --unsafe --silent add . TimeSheets/2011-03-21/all.tji ))
+      end
+      unless res.returnValue == 0
+        raise "Project reloading failed: #{res.stdErr}"
+      end
+
+      res = stdIoWrapper do
+        Tj3TsSummary.new.main(%w( --dryrun --silent -e 2011-03-21 ))
+      end
+      @sum_mails = collectMails(res.stdOut)
+      unless res.returnValue == 0
+        raise "Summary generation failed: #{res.stdErr}"
+      end
     end
 
     after(:all) do
@@ -88,19 +181,115 @@ EOT
       cd(@pwd)
     end
 
-    it 'should generate properly dated headers' do
-      countLines(@res.stdOut,
-                 'timesheet r1 2011-03-14-00:00-+0000 - ' +
-                 '2011-03-21-00:00-+0000').should == 1
-      countLines(@res.stdOut,
-                 'timesheet r2 2011-03-14-00:00-+0000 - ' +
-                 '2011-03-21-00:00-+0000').should == 1
+    describe TimeSheetSender do
+
+      it 'should have generated 2 mails' do
+        @tss_mails.length.should == 2
+      end
+
+      it 'should have email sender foo@example.com' do
+        @tss_mails.each do |mail|
+          mail.from[0].should == 'foo@example.com'
+        end
+      end
+
+      it 'should have proper email receivers' do
+        @tss_mails[0].to[0].should == 'r1@example.com'
+        @tss_mails[1].to[0].should == 'r2@example.com'
+      end
+
+      it 'should generate properly dated headers' do
+        countLines(@tss_mails[0].parts[0].decoded,
+                   'timesheet r1 2011-03-14-00:00-+0000 - ' +
+                   '2011-03-21-00:00-+0000').should == 1
+        countLines(@tss_mails[1].parts[0].decoded,
+                   'timesheet r2 2011-03-14-00:00-+0000 - ' +
+                   '2011-03-21-00:00-+0000').should == 1
+      end
+
+      it 'should have matching timesheets in body and attachment' do
+        @tss_mails.each do |mail|
+          bodySheet = extractTimeSheet(mail.parts[0].decoded)
+          attachedSheet = extractTimeSheet(mail.part[1].decoded)
+          bodySheet.should == attachedSheet
+        end
+      end
+
+    end
+
+    describe TimeSheetReceiver do
+
+      it 'should have generated 2 mails' do
+        @tsr_mails.length.should == 2
+      end
+
+      it 'should have email sender foo@example.com' do
+        @tsr_mails.each do |mail|
+          mail.from[0].should == 'foo@example.com'
+        end
+      end
+
+      it 'should have proper email receivers' do
+        @tsr_mails[0].to[0].should == 'r1@example.com'
+        @tsr_mails[1].to[0].should == 'r2@example.com'
+      end
+
+      it 'should have stored timesheets' do
+        @sheet1.should == File.read('TimeSheets/2011-03-21/r1_2011-03-21.tji')
+        @sheet2.should == File.read('TimeSheets/2011-03-21/r2_2011-03-21.tji')
+      end
+
+      it 'should report an error on bad keyword' do
+        sheet = <<'EOT'
+# --------8<--------8<--------
+timesheet r2 2011-03-14-00:00-+0000 - 2011-03-21-00:00-+0000 {
+
+  task t3 {
+    wirk 100.0%
+    remaining 5.0d
+    status green "All green!"
+  }
+}
+# -------->8-------->8--------
+EOT
+        mail = Mail.new do
+          subject "Timesheet"
+          content_type [ 'text', 'plain', { 'charset' => 'UTF-8' } ]
+          content_transfer_encoding 'base64'
+          body sheet.unix2dos.to_base64
+        end
+        mail.to = 'taskjuggler@example.com'
+        mail.from 'r@example.com'
+        res = stdIoWrapper(mail.to_s) do
+          Tj3TsReceiver.new.main(%w( --dryrun --silent ))
+        end
+        countLines(res.stdErr,
+                   /\.\:5\: Error\: Unexpected token 'wirk' found\./).should == 1
+        res.returnValue.should == 1
+      end
+
     end
 
-    it 'should generate 2 emails' do
-      countLines(@res.stdOut, 'From: foo@example.com').should == 2
-      countLines(@res.stdOut, 'To: r1@example.com').should == 1
-      countLines(@res.stdOut, 'To: r2@example.com').should == 1
+    describe TimeSheetSummary do
+
+      it 'should have generated 4 mails' do
+        @sum_mails.length.should == 4
+      end
+
+      it 'should have proper email receivers' do
+        @sum_mails[0].to[0].should == 'archive@example.com'
+        @sum_mails[1].to[0].should == 'archive@example.com'
+        @sum_mails[2].to[0].should == 'archive@example.com'
+        @sum_mails[3].to[0].should == 'crew@example.com'
+      end
+
+      it 'should have proper email senders' do
+        @sum_mails[0].from[0].should == 'r1@example.com'
+        @sum_mails[1].from[0].should == 'r2@example.com'
+        @sum_mails[2].from[0].should == 'foo@example.com'
+        @sum_mails[3].from[0].should == 'foo@example.com'
+      end
+
     end
 
     private
@@ -119,8 +308,40 @@ EOT
       c
     end
 
+    def extractTimeSheet(lines)
+      sheet = nil
+      lines.each_line do |line|
+        if line =~ /^# --------8<--------8<--------/
+          sheet = ""
+        elsif line =~ /^# -------->8-------->8--------/
+          raise 'Found end marker, but no start marker' unless sheet
+          return sheet
+        elsif sheet
+          sheet += line
+        end
+      end
+      raise "No end marker found"
+    end
+
+    def collectMails(lines)
+      mails = []
+      mailLines = nil
+      lines.each_line do |line|
+        if line =~ /^-- Email Start ---/
+          mailLines = ""
+        elsif line =~ /^-- Email End ---/
+          raise 'Found end marker, but no start marker' unless mailLines
+          mails << Mail.read_from_string(mailLines)
+          mailLines =  nil
+        elsif mailLines
+          mailLines += line
+        end
+      end
+      mails
+    end
+
     def cleanup
-      rm_rf %w( TimeSheetTemplates timesheets.log tj3.log tj3ts_sender.log )
+      rm_rf %w( TimeSheetTemplates TimeSheets timesheets.log tj3.log tj3ts_sender.log tj3ts_receiver.log )
     end
 
   end