[Bio] / askkb / doc / change_requests.txt Repository:
ViewVC logotype

Annotation of /askkb/doc/change_requests.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (view) (download)

1 : brettin 1.1 ------------------------------------------------------------------------------
2 :     Once software is placed in a controlled baseline, all changes are tracked. A
3 :     distinction must be made for the cause of a change. The change categories are:
4 :    
5 :     Type 0: Critical failures, which are defects that are nearly always fixed
6 :     before any external release. In general, these sorts of changes represent
7 :     showstoppers that have an impact on the usability of the software in its
8 :     critical use cases.
9 :    
10 :     Type 1: A bug or defect that either does not impair the usefulness of the
11 :     system or can be worked around. Such errors tend to correlate with nuisances
12 :     in critical use cases or serious defects in secondary use cases that have a
13 :     low probability of occurrence.
14 :    
15 :     Type 2: A change that is an enhancement rather than a response to a defect.
16 :     Its purpose is typically to improve performance, testability, usability, or
17 :     some other aspect of quality that represents good value engineering.
18 :    
19 :     Type 3: A change that is necessitated by an update to the requirements. This
20 :     could be new features or capabilities that are outside the scope of the
21 :     current vision and business case.
22 :    
23 :     Type 4: Changes that are not accommodated by the other categories.
24 :     ------------------------------------------------------------------------------
25 :     DATE
26 :     CHANGE
27 :     PURPOSE
28 :     TYPE
29 :     REQUESTOR
30 :     APPROVED BY
31 :     APPROVAL DATE
32 :     CHANGED BY
33 :     CHANGE DATE
34 :     FILES AFFECTED
35 :     COMMENT
36 :    
37 :     DATE
38 :     CHANGE Remove code from AskKB.psgi that sets the location of the storage dir
39 :     and move this code to the AskKBImpl.pm file.
40 :     PURPOSE To allow the psgi file to be completely auto-generated.
41 :     TYPE 2
42 :     REQUESTOR Tom
43 :     APPROVED BY
44 :     APPROVAL DATE
45 :     CHANGED BY Tom
46 :     CHANGE DATE
47 :     FILES AFFECTED AskKB.psgi, AskKBImpl.pm, deploy.cfg
48 :     COMMENT The location of the storage dir will be specified in a deploy.cfg
49 :     file for use in test and production deployments. In addition, we'll hard code
50 :     a location in the AskKBImpl.pm file that can be over written if
51 :     $ENV{KB_DEPLOY_CONFIG} is set an points to a valid file and that file contains
52 :     the storage_dir field and if the value assocated with the storage_dir field
53 :     is a writiable directory.
54 :    
55 :     Specifically, the following lines of code are removed from the psgi file:
56 :     my $storage_dir = "/tmp/storage1";
57 :    
58 :     my $kb_storage_dir = "/xfs/kb_inst/askKB_storage";
59 :    
60 :     if (-d $kb_storage_dir && -w $kb_storage_dir)
61 :     {
62 :     $storage_dir = $kb_storage_dir;
63 :     }
64 :    
65 :     and the following added to AskKBImpl.pm at the class level between
66 :     the #BEGIN HEADER and #END HEADER tokens.
67 :    
68 :     #BEGIN HEADER
69 :    
70 :     # set package variables
71 :    
72 :     our $cfg = {};
73 :     if (defined $ENV{KB_DEPLOYMENT_CONFIG} && -e $ENV{KB_DEPLOYMENT_CONFIG}) {
74 :     $cfg = new Config::Simple($ENV{KB_DEPLOYMENT_CONFIG}) or
75 :     Bio::KBase::Exceptions::ArgumentValidationError->throw(error => Config::Simple->error(),
76 :     method_name => 'new');
77 :     }
78 :     else {
79 :     $cfg = new Config::Simple(syntax=>'ini') or
80 :     Bio::KBase::Exceptions::ArgumentValidationError->throw(error => Config::Simple->error(),
81 :     method_name => 'new');
82 :     $cfg->param('askdb.storage_dir', '/var/tmp');
83 :     }
84 :    
85 :     #END HEADER
86 :    
87 :     And in the AskDBImpl.pm constructor, set the value of $self->{storage_dir} =
88 :     $cfg->{askkb.storage_dir}
89 :    

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3