SRTool Developer Page - Revision history

David Reyna: /* Debugging the SRTool */

2019-02-23T00:15:17Z

Debugging the SRTool

← Older revision		Revision as of 00:15, 23 February 2019
Line 683:		Line 683:

	<strong>Notes</strong>:		<strong>Notes</strong>:
	* ~~This~~ variable is used by the SRTool runtime to provide the root directory for all of the SRTool resources, for example the database, data files, log files, and helper scripts.		* The variable SRT_BASE_DIR is used by the SRTool runtime to provide the root directory for all of the SRTool resources, for example the database, data files, log files, and helper scripts.
	* It is also required for the Django/SRTool management functions. For such operations (like super user creation and model migrations), it is recommended to use "./bin/srt manage ..." to allow the "srt" tool to automatically and correctly prepare this and any other required environment variables.		* The variable SRT_BASE_DIR is used to define SRT_SQLITE_DEFAULT_DIR
			* The variable SRT_BASE_DIR is also required for the Django/SRTool management functions. For such operations (like super user creation and model migrations), it is recommended to use "./bin/srt manage ..." to allow the "srt" tool to automatically and correctly prepare this and any other required environment variables and then invoke the requested management function.
	<br/>		<br/>

David Reyna: /* Debugging the SRTool */

2019-02-23T00:09:30Z

Debugging the SRTool

@@ Line 666: / Line 666: @@
 <strong>Notes</strong>:
 * Holding the user name and password as environment variables is a good way to hide them from external users that may have read access to the SRTool file system
 <br/>

David Reyna: /* Report/Export System */

2019-01-30T05:00:48Z

Report/Export System

@@ Line 385: / Line 385: @@
 * Ability to easily add new reports and new output formats
 ** Examine "lib/acme/reports.py" to see how to easily extend and/or replace existing report implementations for custom master applications
 <br/>

David Reyna: /* Patcher Usage overview */

2019-01-25T02:51:32Z

Patcher Usage overview

← Older revision		Revision as of 02:51, 25 January 2019
Line 786:		Line 786:
	<code>		<code>
	Merge shared upstream code into a custom Jira script:		Merge shared upstream code into a custom Jira script:
	$ ./bin/common/srtool_patcher.py -j bin/acme/patcher.json --merge-original		$ ./bin/common/srtool_patcher.py -J bin/acme/patcher.json --merge-original
	Merge edits in script's common code areas back to upstream:		Merge edits in script's common code areas back to upstream:
	$ ./bin/common/srtool_patcher.py -j bin/acme/patcher.json --merge-custom		$ ./bin/common/srtool_patcher.py -J bin/acme/patcher.json --merge-custom
	See if the shared common code sections have diverged from upstream:		See if the shared common code sections have diverged from upstream:
	$ ./bin/common/srtool_patcher.py -j bin/acme/patcher.json --diff-original		$ ./bin/common/srtool_patcher.py -J bin/acme/patcher.json --diff-original
	Extract the custom code sections, for examining and preserving custom changes:		Extract the custom code sections, for examining and preserving custom changes:
	$ ./bin/common/srtool_patcher.py -j bin/acme/patcher.json --extract-custom-patch		$ ./bin/common/srtool_patcher.py -J bin/acme/patcher.json --extract-custom-patch
	Stash then clean the custom code sections from a shared upstream file:		Stash then clean the custom code sections from a shared upstream file:
	$ ./bin/common/srtool_patcher.py -J bin/acme/patcher.json --clean-inplace		$ ./bin/common/srtool_patcher.py -J bin/acme/patcher.json --clean-inplace

David Reyna: /* Patcher Usage Examples */

2019-01-25T02:51:15Z

Patcher Usage Examples

← Older revision		Revision as of 02:51, 25 January 2019
Line 814:		Line 814:

	<code>		<code>
	$ ./bin/common/srtool_patcher.py -j bin/acme/patcher.json --diff-original		$ ./bin/common/srtool_patcher.py -J bin/acme/patcher.json --diff-original
	== DIFF from 'bin/common/srtool_jira_template.py' to clean version of custom file ===		== DIFF from 'bin/common/srtool_jira_template.py' to clean version of custom file ===
	--- bin/common/srtool_jira_template.py 2019-01-17 19:01:51.375018816 -0800		--- bin/common/srtool_jira_template.py 2019-01-17 19:01:51.375018816 -0800
Line 829:		Line 829:

	<code>		<code>
	$ ./bin/common/srtool_patcher.py -j bin/acme/patcher.json --merge-custom		$ ./bin/common/srtool_patcher.py -J bin/acme/patcher.json --merge-custom
	== Copying clean version of custom file to 'bin/common/srtool_jira_template.py' ===		== Copying clean version of custom file to 'bin/common/srtool_jira_template.py' ===
	cp -f bin/acme/patcher/srtool_jira_acme.py.clean bin/common/srtool_jira_template.p		cp -f bin/acme/patcher/srtool_jira_acme.py.clean bin/common/srtool_jira_template.p
Line 851:		Line 851:
	$ git checkout bin/common/srtool_jira_template.py		$ git checkout bin/common/srtool_jira_template.py
	$		$
	$ ./bin/common/srtool_patcher.py -j bin/acme/patcher.json --merge-original		$ ./bin/common/srtool_patcher.py -J bin/acme/patcher.json --merge-original
	Custom File: bin/acme/srtool_jira_acme.py		Custom File: bin/acme/srtool_jira_acme.py
	Clean File: bin/acme/patcher/srtool_jira_acme.py.clean		Clean File: bin/acme/patcher/srtool_jira_acme.py.clean
Line 869:		Line 869:
	5. If there is a problem merging the upstream code, for example a change is too close to a custom section, you will see something like:		5. If there is a problem merging the upstream code, for example a change is too close to a custom section, you will see something like:
	<code>		<code>
	$ ./bin/common/srtool_patcher.py -j bin/acme/patcher.json --merge-original		$ ./bin/common/srtool_patcher.py -J bin/acme/patcher.json --merge-original
	...		...
	patch bin/acme/srtool_jira_acme.py bin/acme/patcher/srtool_jira_acme.py.patch		patch bin/acme/srtool_jira_acme.py bin/acme/patcher/srtool_jira_acme.py.patch

David Reyna: /* Defect System Integration */

2019-01-25T00:53:54Z

Defect System Integration

@@ Line 329: / Line 329: @@
 === Defect System Integration ===
-* Ability to import CVE affected defects from Defect system
+The organization's Defect System integration script is expected to fulfill these requirements. The SRTool expects these actions to be defined the 'data source' that wraps the defect system integration script:
-* Ability to create new CVE affected defects to Defect system
+* <strong>Update command</strong>: this will perform the initial population of the SRTool of the CVE-affected defects in the Defect system
-* Ability to update CVE status from Defect system
+* <strong>Refresh command</strong>: this will perform a refresh of the SRTool of the CVE-affected defects in the Defect system, updating existing records and creating any new ones
 <br/>
 === Report/Export System ===

David Reyna: /* Data backup and Recovery */

2019-01-21T07:55:39Z

Data backup and Recovery

← Older revision		Revision as of 07:55, 21 January 2019
Line 462:		Line 462:
	* To restore the data:		* To restore the data:
	** Stop the SRTool server		** Stop the SRTool server
	** Delete of move the current sqlite file		** Delete or move the current sqlite file
	** Copy the contents of the selected backup directory onto the SRTool base directory		** Copy the contents of the selected backup directory onto the SRTool base directory
	** Start the SRTool server		** Start the SRTool server

David Reyna: /* Data backup and Recovery */

2019-01-21T07:54:23Z

Data backup and Recovery

← Older revision		Revision as of 07:54, 21 January 2019
Line 453:		Line 453:
	=== Data backup and Recovery ===		=== Data backup and Recovery ===

	* ~~Ability~~ to ~~regularly~~ backup data ~~via scripts and a CRON job~~		* There are data sources that perform background backups
	* ~~Ability to~~ restore data		** The 'daily' backup save the data to 'backups/backup_$weekday'
			** The 'weekly backup save the data to 'backups/backup_$year_$weeknum'
			* The backed up data includes:
			** The sqlite database
			** The downloaded data files (but not the cache files)
			** The downloaded attachment files
			* To restore the data:
			** Stop the SRTool server
			** Delete of move the current sqlite file
			** Copy the contents of the selected backup directory onto the SRTool base directory
			** Start the SRTool server

	<br/>		<br/>

David Reyna: /* Patcher Usage Examples */

2019-01-20T02:34:04Z

Patcher Usage Examples

@@ Line 906: / Line 906: @@
 </code>
-. Receiving from upstream any changes to common areas. If there is an upstream change to "bin/srt", you would:
+. Make a change to the public section in the customized file
 * Run '--clean-inplace' to stash the customizations
 * Run 'git pull' the get the upsteam changes
 * Run '--patch-inplace' to merge the customizations
 . Pushing to upstream any changes to common areas. If you would like to commit a change to the common sections of "bin/srt", you would:
 * Run '--clean-inplace' to stash the customizations
 * Run 'git add/commit' the updated file

David Reyna: /* Patcher Usage Examples */

2019-01-19T23:20:38Z

Patcher Usage Examples

← Older revision		Revision as of 23:20, 19 January 2019
Line 851:		Line 851:
	Note that for this first time there is no managed patch file, so the customized version will simple be copied.		Note that for this first time there is no managed patch file, so the customized version will simple be copied.

	3. Observe that the custom ~~section is~~ in place		3. Observe that the custom sections are in place, one insertion and one exclude/replace:

	<code>		<code>
	$ git diff bin/srt		$ git diff bin/srt
	diff --git a/bin/srt b/bin/srt		diff --git a/bin/srt b/bin/srt
	index 41753b7..~~eaa7cd3~~ 100755		index 41753b7..af8a1fb 100755
	--- a/bin/srt		--- a/bin/srt
	+++ b/bin/srt		+++ b/bin/srt
Line 862:		Line 862:
	# You should have received a copy of the GNU General Public License		# You should have received a copy of the GNU General Public License
	# along with this program. If not, see http://www.gnu.org/licenses/.		# along with this program. If not, see http://www.gnu.org/licenses/.

	+### ACME_EXTENSION_BEGIN ###		+### ACME_EXTENSION_BEGIN ###
	+echo "Welcome to the SRTool, ACME Edition!"		+echo "Welcome to the SRTool, ACME Edition!"
Line 870:		Line 870:
	HELP="		HELP="
	Usage: source srt start\|stop [webport=<address:port>]		Usage: source srt start\|stop [webport=<address:port>]
	Optional arguments:		Optional arguments:
			@@ -261,7 +266,17 @@ elif [ "$CMD" = "" ]; then
			exit 1
			fi

			-echo "The system will $CMD."
			+### ACME_EXTENSION_EXCLUDE_BEGIN ###
			+#echo "The system will $CMD."
			+#
			+### ACME_EXTENSION_EXCLUDE_END ###
			+### ACME_EXTENSION_BEGIN ###
			+#
			+# NOTE: Exclusions should be used only when necessary
			+# NOTE: The excluded lines are commented so that they are inactive but restorable
			+#
			+echo "The ACME SRTool system will now $CMD!"
			+### ACME_EXTENSION_END ###

			# Execute the commands
			case $CMD in
	$		$
	</code>		</code>
Line 897:		Line 916:
	* Run '--patch-inplace' to re-merge the customizations		* Run '--patch-inplace' to re-merge the customizations

	<br>		<br/>

	== Submitting Patches to the SRTool via GitLab ==		== Submitting Patches to the SRTool via GitLab ==