-
Notifications
You must be signed in to change notification settings - Fork 0
/
saassist-server_contributing.html
118 lines (98 loc) · 3.87 KB
/
saassist-server_contributing.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<meta name="author" content="Kairo Araujo">
<META NAME="generator" CONTENT="http://txt2tags.org">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
<LINK REL="stylesheet" TYPE="text/css" HREF="site.css">
<TITLE>Security APAR Assistant</TITLE>
<link rel="icon" type="image/png" href="/favicon.png">
</HEAD>
<BODY>
<DIV CLASS="header" ID="header">
<H1>Security APAR Assistant</H1>
<H3>Contributing</H3>
</DIV>
<DIV CLASS="body" ID="body">
<div id="sidebar">
<ul>
<li id="home"><a href="./index.html">Home</a></li>
<li id="howitworks"><a href="./howitworks.html">How it Works</a></li>
<li id="SAAssist Server Install"><a href="./saassist-server_install.html">SAAssist Server Install</a></li>
<li id="SAAssist Client Install"><a href="./saassist-server_install.html">SAAssist Client Install</a></li>
<li id="Developing SAAssist Server"><a href="./saassist-server_contributing.html">Developing SAAssist Server</a></li>
<li id="SAA Server releases"><a href="https://github.com/saassist/saassist-server/releases">Download SAA Server Releases</a></li>
<li id="SAA CLient releases"><a href="https://github.com/saassist/saassist-server/releases">Download SAA Client Releases</a></li>
<li id="github"><a href="https://github.com/saassist">Visit GitHub</a></li>
</ul>
</div>
<H1>Contributing with Security APAR Assistant Server</H1>
<P>
SAAssist Server (saassist-server) is developed in Python (version 3) language
</P>
<P>
and SAAssist Client (saassist-client) is developed in Korn Shell (ksh).
</P>
<H2>Reporting bugs</H2>
<P>
SAAssist Server <A HREF="https://github.com/SAAssist/saassist-server/issues">https://github.com/SAAssist/saassist-server/issues</A>
</P>
<P>
SAAssist Client <A HREF="https://github.com/SAAssist/saassist-client/issues">https://github.com/SAAssist/saassist-client/issues</A>
</P>
<H2>To Do</H2>
<UL>
<LI>[server/client] implement checksum for files
<LI>[server/client] Include support for ftp protocol
<LI>[server] Create all unit tests for Python code
<LI><S>[server] Avoid to store the same fix for different versions to reduce</S>
<S>data storage usage.</S>
<P></P>
== New code or bug fixes ==
<P></P>
1. Do the fork from <A HREF="http://github.com/SAAssist/saassist-server">http://github.com/SAAssist/saassist-server</A>
<P></P>
2. Do the clone from your fork <CODE>git clone http://github.com/username/saassist-server</CODE>
<P></P>
3. Create a branch <CODE>git checkout -b new_feature</CODE> or <CODE>git checkout -b bug_000X</CODE>
<P></P>
4. Do your code or fix a bug :)
<P></P>
5. Run tests <CODE>tox -e py34</CODE> (if your version is Python 3.5 use py35)
<P></P>
6. Submit your code to review <CODE>git-review</CODE>
</UL>
<H2>saassist-server structure</H2>
<PRE>
* server_config.py is the configuration file (basic variables)
* saassist-server(.py) is the command constructor
* saassist/saaserver.py is the server manager (repository content manager)
- SAAServer()
. repo_creation()
* saassist/datacollector.py is the data collector that works with FLRT site
- Collector()
. apar_data()
</PRE>
<H3>SCHEMA</H3>
<PRE>
1. [ saassist-server.py ]
{ user: CVE / IV }
{ user: update or no }
--> saassist/saaserver.py
2. [ saassist/saaserver.py ]
{ invoke datacollector.py with CVE/IV }
--> saassist/datacollector.py
3. [ saassist/datacollector.py ]
{ access FLRT website }
{ do parsing of data }
{ return the data in a dictionary }
saassist/saaserver <--
4. [ saassist/saaserver.py ]
{ validate data }
{ create the repository data }
{ output actions: user }
</PRE>
</DIV>
<!-- html code generated by txt2tags 2.6 (http://txt2tags.org) -->
<!-- cmdline: txt2tags howitworks.t2t index.t2t contributing.saassist-server_doc.t2t.t2t -->
</BODY></HTML>