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

View of /askkb/doc/change_requests.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (download) (annotate)
Wed May 1 04:19:12 2013 UTC (6 years, 6 months ago) by brettin
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +0 -0 lines
new file

------------------------------------------------------------------------------ 
Once software is placed in a controlled baseline, all changes are tracked. A
distinction must be made for the cause of a change. The change categories are:

Type 0: Critical failures, which are defects that are nearly always fixed 
before any external release. In general, these sorts of changes represent 
showstoppers that have an impact on the usability of the software in its
critical use cases.
 
Type 1: A bug or defect that either does not impair the usefulness of the 
system or can be worked around. Such errors tend to correlate with nuisances
in critical use cases or serious defects in secondary use cases that have a 
low probability of occurrence.

Type 2: A change that is an enhancement rather than a response to a defect.
Its purpose is typically to improve performance, testability, usability, or
some other aspect of quality that represents good value engineering.

Type 3: A change that is necessitated by an update to the requirements. This 
could be new features or capabilities that are outside the scope of the 
current vision and business case.

Type 4: Changes that are not accommodated by the other categories. 
------------------------------------------------------------------------------
DATE		
CHANGE	
PURPOSE	
TYPE			
REQUESTOR		
APPROVED BY		
APPROVAL DATE	
CHANGED BY  
CHANGE DATE 
FILES AFFECTED
COMMENT

DATE
CHANGE Remove code from AskKB.psgi that sets the location of the storage dir
and move this code to the AskKBImpl.pm file.
PURPOSE	To allow the psgi file to be completely auto-generated.
TYPE	2
REQUESTOR	Tom
APPROVED BY	
APPROVAL DATE	
CHANGED BY	Tom
CHANGE DATE
FILES AFFECTED	AskKB.psgi, AskKBImpl.pm, deploy.cfg
COMMENT	The location of the storage dir will be specified in a deploy.cfg
file for use in test and production deployments. In addition, we'll hard code
a location in the AskKBImpl.pm file that can be over written if
$ENV{KB_DEPLOY_CONFIG} is set an points to a valid file and that file contains
the storage_dir field and if the value assocated with the storage_dir field
is a writiable directory.

Specifically, the following lines of code are removed from the psgi file:
my $storage_dir = "/tmp/storage1";

my $kb_storage_dir = "/xfs/kb_inst/askKB_storage";
 
if (-d $kb_storage_dir && -w $kb_storage_dir)
{
    $storage_dir = $kb_storage_dir;
}

and the following added to AskKBImpl.pm at the class level between
the #BEGIN HEADER and #END HEADER tokens.

#BEGIN HEADER

# set package variables

our $cfg = {};
if (defined $ENV{KB_DEPLOYMENT_CONFIG} && -e $ENV{KB_DEPLOYMENT_CONFIG}) {
    $cfg = new Config::Simple($ENV{KB_DEPLOYMENT_CONFIG}) or
        Bio::KBase::Exceptions::ArgumentValidationError->throw(error => Config::Simple->error(),
                                                         method_name => 'new');
}
else {
    $cfg = new Config::Simple(syntax=>'ini') or
        Bio::KBase::Exceptions::ArgumentValidationError->throw(error => Config::Simple->error(),
                                                         method_name => 'new');
    $cfg->param('askdb.storage_dir', '/var/tmp');
}

#END HEADER

And in the AskDBImpl.pm constructor, set the value of $self->{storage_dir} =
$cfg->{askkb.storage_dir}


MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3