Project

General

Profile

Support #1569

identify and remove any customer-specific references inside the P2J project

Added by Greg Shah almost 12 years ago. Updated over 7 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Costin Savin
Target version:
-
Start date:
09/24/2012
Due date:
% Done:

100%

billable:
No
vendor_id:
GCD
case_num:
version_reported:
version_resolved:

cs_upd_20121015.zip - proposed update (631 KB) Costin Savin, 10/15/2012 01:02 PM

cs_upd20121001a.zip - Original changes (obsolete now). (621 KB) Greg Shah, 10/26/2012 01:01 PM

cs_upd20121031a.zip (827 KB) Costin Savin, 10/31/2012 01:31 PM

cs_upd20121101a.zip (28.6 KB) Costin Savin, 11/01/2012 07:39 AM

cs_upd20121116b.zip (787 KB) Costin Savin, 11/16/2012 02:08 PM

cs_upd20121116b.zip (28.5 KB) Costin Savin, 11/16/2012 02:09 PM

cs_upd20121119a.zip (28.5 KB) Costin Savin, 11/19/2012 07:39 AM

cs_upd20121119b.zip (570 KB) Costin Savin, 11/19/2012 07:41 AM

cs_upd20121121b.zip (570 KB) Costin Savin, 11/21/2012 11:01 AM

cs_upd20121121c.zip (569 KB) Costin Savin, 11/21/2012 12:42 PM

cs_upd20121122a.zip (569 KB) Costin Savin, 11/22/2012 05:13 AM

History

#1 Updated by Greg Shah almost 12 years ago

At this time, the only customer references are for TIMCO and Majic. The P2J project itself should NEVER have customer-specific references (even in the comments). The primary reason is that all code should be generic. But a secondary reason is to honor our confidentiality agreements with our customers. Putting such data in our code or documentation breaks that confidentiality.

Please carefully search through all the code, javadoc, comments, testcases, scripts, package.html files and so forth (the whole project). Look for explicit references to timco and majic. But it is important to note that these may be mis-spelled. For example, in com/goldencode/p2j/admin/client/AdminACL.java there is this code: showByResourceType("majic-function").

Please also look for any references to TIMCO or Majic in our books.

And in the testcases, there are many such references.

In all the found cases, please prepare modifications to safely remove/replace the references. For example, in the testcases, such references in strings can be replaced with some other "fake" text that is of the right length.

For anything that is not obvious, please discuss the approach with Constantin or Stanislav.

#2 Updated by Costin Savin almost 12 years ago

  • Status changed from New to WIP

#3 Updated by Costin Savin almost 12 years ago

There are also some Progrees ".p" files that contain reference to timco or majic should those reference be replace or deleted?

#4 Updated by Costin Savin almost 12 years ago

  • File cs_upd20121001a.zip added

#5 Updated by Costin Savin almost 12 years ago

  • File deleted (cs_upd20121001a.zip)

#6 Updated by Costin Savin almost 12 years ago

  • File cs_upd_20121001.zip added

#7 Updated by Greg Shah over 11 years ago

Any 4GL code (.p) files that reference TIMCO or Majic should be modified to eliminate those references. The testcases should still work, but you can make fake names to replace TIMCO and Majic.

#8 Updated by Costin Savin over 11 years ago

Issue Notes:
  • p2j/scr/com/goldencode/expr/package.html contains reference to timco path html:
    The class is loaded directly from memory into the JVM via a <a href="file:///home/ecf/timco/p2j/src/com/goldencode/expr/ExpressionClassLoader.html">custom class loader</a>.
    In this case the class exists in the project but there is no ExpressionClassLoader.html code. Modified the code to:
    The class is loaded directly from memory into the JVM via a <a href="file:///../p2j/src/com/goldencode/expr/ExpressionClassLoader.html">custom class loader</a>.
    In case the ExpressionClassLoader.html will be added this link can be updated.
  • Replaced Majic or timco reference in with placeholders of same or smaller size(where smaller checked if there might be ui problems with length)
  • Deleted or replaced Majic or timco references from other sources depending on importance keeping resource name change persistent in code.
  • Some documentation resources seem to contain obsolete information.For example p2j/p2j_project_guide.html describes install for p2j Milestone 12 (M12) which was delivered October 1, 2007
    this includes archives p2j_20071001.zip and and majic of the form majic_20071001<..>.zip(removed / changed information regarding the majic files ).
    Also in p2j/design/p2j_high_level_design.html beside the majic references there are choices and technologies specific to the majic project ( for example X-Tools)
    Should these documents be removed/redone in the future?

#9 Updated by Greg Shah over 11 years ago

I think the reference to ExpressionClassLoader.html was intended to point to the JavaDoc version which exists (in the built version of P2J) as dist/docs/api/com/goldencode/expr/ExpressionClassLoader.html. I think you can reference this document via a more relative path that will allow it to be resolved. That path should NOT include the top level p2j/ directory. It shouldn't even contain the dist/docs/ path as we cannot be sure of anything except that the api/com/goldencode... will be there in the JavaDoc. Since the package.html that has the reference is in the same directory, can't the reference be cut down to just "ExpressionClassLoader.html" or "./ExpressionClassLoader.html"?


    Replaced Majic or timco reference in with placeholders of same or smaller size(where smaller checked if there might be ui problems with length)

    Deleted or replaced Majic or timco references from other sources depending on importance keeping resource name change persistent in code.

Good.

Leave the p2j_project_guide.html alone for now. I have pending edits there and will make sure to remove the timco and majic references.

Please make a list (here in the issue history) of the references in the p2j_high_level_design.html. I want to review those and give you feedback. But, yes, I will want you to change that document to remove/replace those references.

#10 Updated by Greg Shah over 11 years ago

The p2j/testcases/simple/server/stdsrvkey.store is a TIMCO-specific file.

Please create new key(s), CA and a store file as needed to replace this file. You will have to update the directory too. You can follow the process documented in the P2J Runtime Installation, Configuration and Administration Guide.

The new version used here should be different from the new one that is being created for chemtutor. Add this to your proposed update.

#11 Updated by Costin Savin over 11 years ago

Attached proposed update 2 : Created new security keystore p2j-server-key.store to replace the majic specific stdsrvkey.store(this should be deleted in this case) inside testcases/simple/server location , also added the certificate authority under testcases/simple/ca location(new)
Removed X-Tools (majic specific) references from p2j_high_level_design.html there are also some reference to Anita terminal software which I didn't remove in place (not sure if majic specific)

#12 Updated by Costin Savin over 11 years ago

  • File deleted (cs_upd_20121001.zip)

#13 Updated by Greg Shah over 11 years ago

#14 Updated by Greg Shah over 11 years ago

Feedback:

1. The update zip file name shouldn't have the extra _ between "upd" and the sortable date. And there should be the "a" at the end of the name.

2. The update zip should have the p2j/ path prefix included.

3. The reference to Anita in design/p2j_high_level_design.html can be removed. It is something TIMCO-specific.

4. The change to src/com/goldencode/p2j/admin/client/AdminACL.java is incorrect. There is no such resource as "app-function". The problem is that this is real Majic code that is mixed into our code. The feature that is provided here should be exposed as a generic hook AND the code that is showing the majic-function resource ACLs should be moved to Majic and exposed via this hook. Please discuss this with Stanislav and Constantin.

5. The references to "app-functions" in src/com/goldencode/p2j/security/SecurityAdmin.java should instead be something more descriptive like "application-specific-acls".

6. The entire "Use of Multiple Databases" section should be deleted from src/com/goldencode/p2j/uast/package.html.

7. The src/com/goldencode/p2j/ui/ColorSpec.java should just delete the text "- not used in MAJIC" instead of changing the word MAJIC to application.

8. In src/com/goldencode/p2j/ui/FillInConfig.java, just remove the affected comment completely.

9. In src/com/goldencode/p2j/ui/chui/ThinClient.java, the first change should replace "found in MAJIC training menu.Roster report." with "found in customer application code.".

10. I see in the testcases (the .p files) that there are references to GSO, GREENSBORO and SYMAN/syman. These should be removed too, as they are specific to TIMCO/Majic.

11. All .java files need to be checked to see if their copyright notice dates need to be changed.

12. All .java files need to have a history entry added.

#15 Updated by Costin Savin over 11 years ago

Added proposed update with fixed issues

#16 Updated by Greg Shah over 11 years ago

  • Target version set to Milestone 2

#17 Updated by Costin Savin over 11 years ago

Forgot to add MajicAdminClient changes for the issues # 4 (feature provided here should be exposed as a generic hook AND the code that is showing the majic-function resource ACLs should be moved to Majic and exposed via this hook.)

#18 Updated by Greg Shah over 11 years ago

Feedback:

1. In MajicAdminClient the @Override annotation should be after the JavaDoc and before the method. Also make sure the alignment/spacing is right.
2. ClientAccountExtension is missing a history entry AND the copyright date needs update.
3. STANISLAV: what do you think about the placement of this new showStandaloneAcls() as part of ClientAccountExtension? It seems out of place to me, but I'm not sure where else it should go.
4. Don't include the character.java (it has your unapproved quoter() methods). It has nothing to do with this update, right?

#19 Updated by Stanislav Lomany over 11 years ago

3. STANISLAV: what do you think about the placement of this new showStandaloneAcls() as part of ClientAccountExtension? It seems out of place to me, but I'm not sure where else it should go.

You don't need showStandaloneAcls function:
1. make AdminACL.showByResourceType public
2. remove

if (standalone)
{
  showByResourceType("majic-function");
}

from AdminACL c'tor
3. Into MajicAdminClient.editFunctionACL use:
AdminACL aacl = new AdminACL(client, true, name);
aacl.showByResourceType("majic-function");

Note: I haven't tried to implement it.

#20 Updated by Greg Shah over 11 years ago

Yes, I like this approach much better.

Costin: please implement as Stanislav has suggested.

#21 Updated by Greg Shah over 11 years ago

On the testcase changes, you can go ahead and check them into the new Bazaar testcases project.

#22 Updated by Costin Savin over 11 years ago

So the testcase changed files should not be included in the proposed update archive?

#23 Updated by Costin Savin over 11 years ago

Added p2j proposed update (testcases are also included in archive). Also commited testcases to bzr

#24 Updated by Costin Savin over 11 years ago

Added majic proposed update

#25 Updated by Greg Shah over 11 years ago

In regards to the testcases, they should be removed from the archive since they are no longer part of P2J. The archive is a way to distribute the P2J changes to systems that don't have Bazaar access.

#26 Updated by Greg Shah over 11 years ago

The design/ changes should be checked into the design project and removed from the P2J archive. Also, the P2J archive name is the same as the proposed majic archive name.

#27 Updated by Greg Shah over 11 years ago

I'm not sure if the added code in MajicAdminClient needs to be further down in the method. Otherwise the change looks OK.

Please test this code path in the Admin UI of a running Majic server.

#28 Updated by Costin Savin over 11 years ago

Checked the changes in the majic admin console it all looks ok.
The code in MajicAdminClient seems to be ok since the addFunctionName(name) method returns true if function already exists or successfully added().
Added the archive with the majic changes since the previous had the same name as the p2j archive.

#29 Updated by Costin Savin over 11 years ago

Commmited the design changes in bzr, attached the p2j archive without the design.

#30 Updated by Greg Shah over 11 years ago

Go ahead with regression testing.

#31 Updated by Greg Shah over 11 years ago

Stanislav: what do you think about the admin console changes? Have you tried them out?

#32 Updated by Greg Shah over 11 years ago

Sorry, I spoke too soon. The SecurityAdmin.java needs to be merged with the one in Bazaar. It has an OM change for H059. Your change will now be H060.

Constantin: on further review of all the changes, I don't see anything here that affects the runtime, except for the admin console changes. Do you see anything I am missing?

If not, then we really don't need to do the regression testing. The final review and check by SVL will be enough.

#33 Updated by Costin Savin over 11 years ago

added revised update with SecurityAdmin OM change included

#34 Updated by Constantin Asofiei over 11 years ago

Constantin: on further review of all the changes, I don't see anything here that affects the runtime, except for the admin console changes. Do you see anything I am missing?

The admin_login.html file has no real change, except that it messes up the format - this should be removed from the archive.

If not, then we really don't need to do the regression testing. The final review and check by SVL will be enough.

Regression testing is not needed.

#35 Updated by Greg Shah over 11 years ago

Please remove the admin_login.html and repost the update.

#36 Updated by Costin Savin over 11 years ago

admin_login.html removed

#37 Updated by Stanislav Lomany over 11 years ago

I'm fine with these changes. However some notes:
1. if you need to change couple of sentences in html, just use a text editor otherwise all html may be reformatted
2. p2j sources should reside in update*.zip/p2j/src, NOT update*.zip/src
3. if a function was made public, its place in the class should be changed accordingly (AdminACL)

#38 Updated by Constantin Asofiei over 11 years ago

2. p2j sources should reside in update*.zip/p2j/src, NOT update*.zip/src

Stanislav, with the latest coding/developer standards, the correct path is update*.zip/src (so you can unzip the archive directly in the root project folder, not in the parent folder).

#39 Updated by Costin Savin over 11 years ago

Added proposed update (changed location of the showByResourceType function, corrected the wrong formatted html file)

#40 Updated by Greg Shah over 11 years ago

1. Check in the P2J changes to the p2j project in Bazaar.
2. Check in the Majic change to the timco project in CVS.
3. Work with Constantin to apply/rebuild the changes to staging. I have already changed the ownership of staging to his userid.
4. Distribute the 2 update zip files to the team.

#41 Updated by Costin Savin over 11 years ago

commited to bzr and csv and sent update mail

#42 Updated by Constantin Asofiei over 11 years ago

The updates have been applied to staging. Majic and P2J was rebuilt.

#43 Updated by Greg Shah over 11 years ago

  • % Done changed from 0 to 100
  • Status changed from WIP to Closed

#44 Updated by Greg Shah over 11 years ago

  • Status changed from Closed to WIP

Costin: you need to re-send the update. The cs_upd20121121d.zip you sent is not the update for this task. I believe you should have sent out the cs_upd20121122a.zip instead.

#45 Updated by Greg Shah over 11 years ago

  • Status changed from WIP to Closed

Sorry, I just caught up to your updated update email. You got it! Thanks.

#46 Updated by Greg Shah over 7 years ago

  • Target version deleted (Milestone 2)

Also available in: Atom PDF