Wiki code for SCM console specification

Hide Line numbers
1: = OpenSolaris
2: 
3: = SCM Project Console Specification
4: 
5: = (DRAFT)
6: 
7: //Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.//
8: 
9: //ident "@(#)d-scm-operational.txt 1.2 06/02/17 SMI"//
10: 
11: == 1. Summary
12: 
13: This document, in concert with the approach outlined in "OpenSolaris source code management implementation" [1], specifies the technical requirements to be added to the Projects feature to support managed source code repositories.
14: 
15: == 2. Discussion
16: 
17: Items suffixed with a (II) are for implementation during the distributed SCM phase. Items suffixed with a (*) are future implementation possibilities.
18: 
19: === 2.1. Components
20: 
21: The implementation requires support from multiple components within the larger infrastructure. Components affected include:
22: 
23: * the web application,
24: * a PAM session module,
25: * an identity update facility,
26: * an automount map generator, and
27: * one or more SCM-specific local execution programs.
28: 
29: (The latter four are assumed to be running on a separate host from the web application, and will be implemented by Sun employees.) This document outlines the changes to the web application that integrate the remaining components. As such, informational text describing the other four components follows.
30: 
31: ==== 2.1.1. PAM session module.
32: 
33: A PAM session module, pam_host_scm.so, will be placed in the local PAM configuration of the SCM host machine. This module will chroot(2) the user to a safe environment and set the umask(2) to 0000.
34: 
35: ==== 2.1.2. Identity update facility.
36: 
37: A cron(1M)-driven job, the update facility will examine the user table on a periodic basis.
38: 
39: Passwords are encoded in the webapp database with an MD5 hash.
40: 
41: ==== 2.1.3. Automount map generator
42: 
43: The safe environment is constructed from a set of key-tied automount entries. These entries are based on each user’s status as a committer in one or more projects.
44: 
45: ==== 2.1.4. SCM-specific local execution programs.
46: 
47: The local execution programs may be separated into three classes: reporting only, modifying, and notification hooks.
48: 
49: Reporting only programs will be implemented as CGI scripts or equivalents that will report as text/plain in response to an HTTP GET query at one or more defined URLs. For example, the svnlook(1) command of Subversion can have its reporting capabilities wrapped in a simple CGI script.
50: 
51: Modifying programs, which require a more complex error channel, will be implemented to invoke functionality from the SCM host daemon. See 2.1.5 for more details.
52: 
53: Minimal use of hook functionality will be offered in the initial release. The only hook, which may need to be installed for multiple operations, will notify the mail alias associated with the repository on SCM operations that modify the files within the repository. (Notification is not provided for administrative operations, such as description changes or committer modifications.)
54: 
55: ==== 2.1.5 SCM host daemon
56: 
57: This daemon is responsible for allowing the web application to interact with the SCM host. Specific responsibilities include:
58: 
59: * Authenticating and Performing remote requests
60: * Securing Remote Requests
61: 
62: Since this is written in Java to facilitate interoperation with the web application, the "SCM-specific local execution programs" must be able to easily interact with Java. The lowest common denominator approach would be to provide Java clients which can be invoked as sub-processes if the "SCM-specific local execution programs" aren’t written in Java.
63: 
64: ===== Interface Definition
65: 
66: The SCM host daemon offers the following remote interfaces:
67: 
68: //Admin interface//
69: 
70: The interface that an Admin server must implement so that an Admin client can determine which operations may be performed by the server and operations that facilitate synchronous or asynchronous execution of a task.
71: 
72: {{{
73: 
74: String[] getOps() throws RemoteException;
75: TaskResult executeTask(Task t) throws RemoteException;
76: URL executeAsyncTask(Task t) throws RemoteException;
77: 
78: }}}
79: 
80: //Task interface//
81: 
82: The interface that an Admin client must implement to allow execution by the Admin server.
83: 
84: {{{
85: 
86: TaskResult execute();
87: String getName();
88: 
89: }}}
90: 
91: === 2.2. Database modifications.
92: 
93: A new object, called a repository, is now tracked by the application. A repository is associated with a project and has a "short name" and a description. The repository is associated with an SCM system of a given type; the first supported type is "svn". A table to track these objects is expected to exist. The repository may or may not be able to be accessed anonymously; the initial setting for the field tracking this access is "true", implying that all repositories allow anonymous access. Each repository has an associated email alias for change notifications. Each repository has a timestamp field containing the date of its creation.
94: 
95: Determining the list of repositories associated with a specific project is accomplished by a query on the repository table that specifies the project ID of the requested project.
96: 
97: Each project now has an additional field, an integer specifying the maximum number of repositories permitted for this project.
98: 
99: Each user now has an additional relationship with each repository on the system. The existence of an entry in the committer table, between a user ID and a repository ID, indicates the ability to perform SCM client operations on that repository. In the initial implementation, although the committer-repository relations are tracked separately, the application will expose only one set of committers per project, and assign each committer to each repository associated with the project.
100: 
101: If a user is made a "project editor", his or her account should also be given committer privileges for the repositories associated with that project. Upon loss of editorship, the user retains committer rights (which may be removed manually).
102: 
103: Upon user deletion, committer rights entries should be removed.
104: 
105: The database is implemented in MySQL. See Appendix A for MySQL specific tables outlining the required database changes.
106: 
107: === 2.3. Project page changes and related modifications
108: 
109: The project page, http://opensolaris.org/os/project/[project], shall have a new left hand menu item entitled "Repositories". Clicking on that link will load a new page, as described in the following section.
110: 
111: The project profile page, entitled "Edit Project" and with URL http://www.opensolaris.org/os/projects/editProject.jspa, needs a new property entry, "Maximum number of repositories".
112: 
113: === 2.4. Repositories page
114: 
115: The new "Repositories" page is the primary reporting page for a project’s source code repositories. The page will consist of a table that lists the code repositories, displaying their names and descriptions, the mailing list they send notifications to, and the URLs used to access them from their appropriate SCM and from HTTP access. The table will further list the committers to the repository.
116: 
117: Furthermore, each repository will offer a list of status operation links to the SCM host. The URL for these links for repositories of type "svn" is
118: 
119: {{code}} http://svn.opensolaris.org/svnlook.cgi?project=[project]& \ repository=[repository]&operation=[operation]&result=xhtml {{/code}}
120: 
121: Valid operations for this listing are "author", "changed", "date", "dirs-changed", "info", "log", "uuid", "youngest". (The svnlook.cgi script, noted in 2.1.4, may support additional invocation options that can be supported at a later date.)
122: 
123: === 2.5. Project leader menu
124: 
125: The project leader menu will require the addition of items allowing access to repository operations. To be consistent with the other menus of this kind, items entitled "Find Repositories" and "Add Repository" will be added.
126: 
127: Additionally, to manage committers, a "Manage Committers" item will be needed.
128: 
129: Each of these items brings up a distinct page, as explained in the following subsections.
130: 
131: ==== 2.5.1. Find Repositories page
132: 
133: The Find Repository page allows the querying of the set of repositories owned by this project. Upon page load, the Find Repositories page will display the results of the default query, which is unpopulated and meant to match all repositories. The project leader may then perform an additional filtering query to reduce the result set.
134: 
135: The query form should present three fields for the query: short name, description, and repository type. The short name and description fields are text entry fields. The repository type is a radio selection from "Subversion" and "Don’t Care".
136: 
137: Selecting a specific repository from the result set table leads to the "Manage Repository" page being loaded.
138: 
139: ==== 2.5.2. Manage Repository page
140: 
141: The Manage Repository page allows the modification of mutable repository properties and the invocation of repository administrative operations. It also permits the deletion of repositories.
142: 
143: The mutable fields for the initial release are the Description text field and the Notification Alias text field. The top portion of the page should present these fields and a "Save" button that submits the operation. Completing the submission should result in a reload of the Manage Repository page, with a short banner encoded as a DIV entity with class "appResult" (henceforth an "appResult" banner) that outlines the success or failure of the modification.
144: 
145: The middle section of the page is concerned with repository operations. These are specific to the repository type, which should be identified in the header at the beginning of the page section.
146: 
147: At this point, the only supported operation is "verify". XXX How is this operation requested?
148: 
149: Completion of the submission of a repository operation should again result in a reload of the Manage Repository page, with a short "appResult" banner at the top of the middle section that describes the outcome of the operation.
150: 
151: The bottom section of the page consists of a single question, "Delete this repository?", and a submit button. A submission of this kind should result in a second verification question ("Are you certain?"). Following this confirmation, the application should request of the SCM host that the repository be deleted. Upon a successful deletion, the application may delete the repository and associated entries from the database. The application should then load the Find Repositories page, and display an "appResult" banner outlining the deletion’s success. In the cases that SCM deletion was unsuccessful, the Manage Repositories page should be displayed with an appropriate "appResult" banner. (The SCM execution agent will send a notification message to the site administrator that contains the reason for the failure.)
152: 
153: ==== 2.5.3. Add Repository page
154: 
155: The Add Repository page allows the creation of new repositories on the system.
156: 
157: The page asks for the following:
158: 
159: * a short name, as a text field,
160: * a description, as a text field,
161: * a notification alias, as a text field,
162: * a repository type, as a radio button field with one choice, "Subversion", and
163: * an allow anonymous access field, as a radio button field with one choice, "Yes".
164: 
165: This should be followed by a submit button with label "Save". The short name must be unique to the repositories managed by this project. The default short name is "main". The submission will result in a request of the SCM execution agent.
166: 
167: On success, the application will record these values, along with the timestamp of the operation, and also create appropriate committer entries. (The initial set of committers is comprised of the project leads at the time of repository creation.) The application should the Find Repositories page, with an appropriate appResult banner at the top of the page.
168: 
169: On failure, the application will redisplay the Add Repository page, with an appResult banner explaining the failure.
170: 
171: ==== 2.5.4. Manage Committers page
172: 
173: This feature is the first where a role other than the Site Administrator can grant capabilites to an individual user. Committers only have capabilities on the SCM host(s), and have no new role in the sense of the web application.
174: 
175: The Manage Committers page presents a selection list of the committers associated with the project. Then, a text field, labelled "New Committers", with an associated submit button, "Add", constitutes the add committer operation. The text field contents may be a space or comma separated list. Each user ID must be a valid OpenSolaris ID.
176: 
177: A further submit button, labelled "Delete Selected", submits a request to removed the selected committer entries from the displayed list.
178: 
179: Both of these operations should reload the Manage Committers page, with an appResult banner outlining the operational outcome.
180: 
181: == 3. Future work
182: 
183: If the site develops support for in-line content macro expansion, macros that generate a list of the project’s repositories should be provided.
184: 
185: Anonymous access may be disallowed for repositories in future ("committers only").
186: 
187: At least one additional repository SCM type is expected.
188: 
189: Additional access to repository information via the Repositories page, such as to OpenGrok-based code browsing is expected.
190: 
191: == 4. References
192: 
193: [1] S. Hahn, "OpenSolaris source code management implementation", 2006.
194: 
195: [2] B. Collins-Sussman, B. W. Fitzpatrick, and C. M. Pilato, "Version Control with Subversion", http://svnbook.red-bean.com/, 2006.
196: 
197: == Appendix A
198: 
199: Database Modifications
200: 
201: === New Table Definitions
202: 
203: ==== Repository
204: 
205: {{{
206: 
207: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
208: |Column Name  |Data Type   |Null |Key|Default    |Notes                    |
209: |             |            |     |   |           |                         |
210: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
211: |ShortName    |TINYTEXT    |  N  | Y |           |Only one row initially   |
212: |             |            |     |   |           |with the value svn.      |
213: |             |            |     |   |           |                         |
214: |             |            |     |   |           |                         |
215: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
216: |Description  |TEXT        |  Y  | N |           |                         |
217: |             |            |     |   |           |                         |
218: |             |            |     |   |           |                         |
219: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
220: |ProjectID    |INT UNSIGNED|  N  | N |           |Foreign Key from Project |
221: |             |            |     |   |           |Table. Confirm data type |
222: |             |            |     |   |           |                         |
223: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
224: |SCMType      |TINYTEXT    |  N  | N |           |Foreign Key to SCMType   |
225: |             |            |     |   |           |table, ShortName Column. |
226: |             |            |     |   |           |                         |
227: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
228: |AnonymousAcc\|TINYINT     |  N  | N |1          |MySQL doesn’t have a     |
229: |ess          |            |     |   |           |BOOLEAN type, so use     |
230: |             |            |     |   |           |TINYINT(1).              |
231: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
232: |Email        |TINYTEXT    |  N  | N |           |                         |
233: |             |            |     |   |           |                         |
234: |             |            |     |   |           |                         |
235: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
236: |Created      |DATETIME    | N   | N |           |Requirements say         |
237: |             |            |     |   |           |TIMESTAMP, but I think   |
238: |             |            |     |   |           |this is better.          |
239: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
240: 
241: }}}
242: 
243: ==== SCMType
244: 
245: {{{
246: 
247: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
248: |Column Name  |Data Type   |Null |Key|Default    |Notes                    |
249: |             |            |     |   |           |                         |
250: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
251: |ShortName    |TINYTEXT    |  N  | Y |           |Only one row initially   |
252: |             |            |     |   |           |with the value svn.      |
253: |             |            |     |   |           |                         |
254: |             |            |     |   |           |                         |
255: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
256: |Description  |TEXT        |  Y  | N |           |                         |
257: |             |            |     |   |           |                         |
258: |             |            |     |   |           |                         |
259: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
260: 
261: }}}
262: 
263: ==== UserRepositories (AKA Committer Table ?)
264: 
265: {{{
266: 
267: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
268: |Column Name  |Data Type   |Null |Key|Default    |Notes                    |
269: |             |            |     |   |           |                         |
270: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
271: |UserName     |TEXT        | N   | Y |           |Foreign Key to UserName  |
272: |             |            |     |   |           |on User Table. Confirm   |
273: |             |            |     |   |           |Data Type.               |
274: |             |            |     |   |           |                         |
275: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
276: |RepositoryNa\|TINYTEXT    |  N  | Y |           |Foreign Key to ShortName |
277: |me           |            |     |   |           |on Repository Table.     |
278: |             |            |     |   |           |                         |
279: |             |            |     |   |           |                         |
280: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
281: 
282: }}}
283: 
284: === Modified Table Definitions
285: 
286: ==== Project
287: 
288: {{{
289: 
290: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
291: |Column Name  |Data Type   |Null |Key|Default    |Notes                    |
292: |             |            |     |   |           |                         |
293: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
294: |MaxRepositor\|INT         |  N  | N |           |                         |
295: |ies          |            |     |   |           |                         |
296: |             |            |     |   |           |                         |
297: |             |            |     |   |           |                         |
298: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
299: 
300: }}}
301: 
302: ==== User
303: 
304: {{{
305: 
306: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
307: |Column Name  |Data Type   |Null |Key|Default    |Notes                    |
308: |             |            |     |   |           |                         |
309: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
310: |ProjectEditor|TINYINT(1)  |  N  | N |           |If set to TRUE, associate|
311: |             |            |     |   |           |the user with all project|
312: |             |            |     |   |           |repositories.            |
313: +~-------------+~------------+~-----+~---+~-----------+~-------------------------+
314: 
315: }}}
316: 
317: //Stephen Hahn, PhD Solaris Kernel Development, Sun Microsystems
318:  stephen dot hahn at sun dot com http://blogs.sun.com/sch///
OpenSolaris

Top Menu

Wiki code for SCM console specification

Search

Collectives

Community Group

Project

User Group

Subsites

Community Group tools Pages
