FAQ's for Developers: Difference between revisions
No edit summary |
|||
| Line 86: | Line 86: | ||
===Q: I cannot find a string which is shown in a dialog, why?=== | ===Q: I cannot find a string which is shown in a dialog, why?=== | ||
Refering to [https://sourceforge.net/apps/mediawiki/openpetraorg/nfs/project/o/op/openpetraorg/d/db/Excample-screen.JPG this screen shoot] you may search for a string like "ImportGL Transactions From Bank Statement" in order to find the piece of code responsible for that entry. The string you should look for is ImportGLTransactionsFromBankStatement, and this leads you directly to the file UINavigation.yml. | Refering to [https://sourceforge.net/apps/mediawiki/openpetraorg/nfs/project/o/op/openpetraorg/d/db/Excample-screen.JPG this screen shoot] you may search for a string like "ImportGL Transactions From Bank Statement" in order to find the piece of code responsible for that entry. The string you should look for is ImportGLTransactionsFromBankStatement, and this leads you directly to the file UINavigation.yml. | ||
===Q: I came across C# code like '... <code>= @TServerLookup.TMCommon.GetData;</code>' - what does it do, what is it for?=== | |||
In the C# programming language the '@MethodName' notation is used for referencing the callee of a Delegate. The @ operator is ''optional'', but it helps when 'scanning program code by eye' to identify such callees (and to find those quickly when using the find functionality of a code editor). | |||
An example code line for that can be found in <code>\csharp\ICT\Petra\Client\app\MainWindow\PetraClientMain.cs</code>, Method <code>'InitialiseClasses'</code>: | |||
TSharedValidationHelper.SharedGetDataDelegate = TServerLookup.TMCommon.GetData; | |||
The code line means in English: ‘Set up the Delegate of Type <code>TSharedGetData</code> which is held in the static Field <code>FDelegateSharedGetData</code> in Class <code>TSharedValidationHelper</code> through its static Property <code>SharedGetDataDelegate</code> to point to the static Method <code>TServerLookup.TMCommon.GetData</code>’. | |||
The purpose of setting this up is that the Method <code>GetData</code> in Ict.Petra.''Shared''.MCommon.Validation.TSharedValidationHelper (which is in a Project that can’t have a reference to any ''client-side'' projects as it is ''shared'' code that can be executed by both client and server) ''can still'' execute a client-side (or a server-side) method - although it is lacking Project References to those DLLs! 'What exactly' ''is'' getting executed at run time in Method <code>GetData</code> depends on whether the client or the server is setting up the <code>SharedGetDataDelegate</code> Delegate, and to which Method on ‘his side’ that points. | |||
Note: The server-side set-up of the Delegate can be found in \csharp\ICT\Petra\Server\lib\CallForwarding\CallForwarding.cs, in the static Constructor of 'TCallForwarding'. | |||
TSharedValidationHelper.SharedGetDataDelegate = @TCommonDataReader.GetData; | |||
===Q: What is the 'SiteKey' and how do I retrieve it?=== | ===Q: What is the 'SiteKey' and how do I retrieve it?=== | ||
Revision as of 08:49, 27 November 2012
Source Code Repository
Q: Which source code repository system are you using?
We use Bazaar. It is a decentralized version control system (DVCS) that helps in tracking project history over time and allows for effective and easy collaboration with many developers in different locations.
This is the link to our Bazaar Repository: [1] (use the special URL lp:openpetraorg within Bazaar Explorer).
Continuous Integration/Build Server
Q: Do you build regularly?
Yes, we do. We have a Continuous Integration server, Hudson. It runs a build after every check-in of source code into our Bazaar source code repository system.
This is the link to our Hudson server: [2]
Notifications of What is Happening
Q: Do you have a Developer's Blog or Mailing Lists?
We don't have a developer's blog and we don't have mailing lists either. We have Forums instead, which can be subscribed to with RSS feeds. The Developer's Forum provides a better structure than a blog for the purposes of communication between developers/potential developers because the Forum provides a threaded format rather than just a long list of entries that is ordered by date.
In addition to that we have hourly notification emails for Forum changes, Mantis Bug changes, and wiki changes that our developers all are subscribed to (such emails are sent only if changes happen, of course). These email notifications can't be subscribed to directly. Instead, an administrator needs to set those up for each developer as they are a done with a custom solution.
Note: We have a Project Blog which is accessible from the 'News' section of the web site, but that is general and not just for developers. It can be subscribed to with RSS feeds.
Additional some OpenPetra developer's have a personal blog. See http://www.openpetra.org/index.php?lang=en&page=developers-blogs
Q: Do you have notifications for source code commits?
No, not at the moment. Source code repository changes can be browsed manually here: [3]
Compiling
Compiler Errors
Q: I get 'File name xyz is too long or invalid' message
[solution] Building 'Ict.Petra.Client.MReporting.Gui.MConference' [Debug] ... [solution] CSC: Error CS2021: File name '..\..\..\..\_bin\ObjCode\Ict.Petra.Client.MReporting.Gui.MConference.TFrmAttendanceSummaryReport.resources' is too long or invalid [solution] Project 'Ict.Petra.Client.MReporting.Gui.MConference' failed! [solution] Continuing build with non-dependent projects. [solution] Building 'Ict.Petra.Client.MFinance.Gui.Gift' [Debug] ... [solution] Building 'Ict.Petra.Client.MPartner.Gui' [Debug] ... [solution] Building 'Ict.Petra.Client.MReporting.Gui.MPersonnel' [Debug] ... File name '..\..\..\..\_bin\ObjCode\Ict.Petra.Client.MReporting.Gui.MConference.TFrmAttendanceSummaryReport.resources' is too long or invalid [solution] CSC: Error CS2021: File name '..\..\..\..\_bin\ObjCode\Ict.Petra.Client.MReporting.Gui.MPersonnel.TFrmEmergencyContactReportStaff.resources' is too long or invalid [solution] Project 'Ict.Petra.Client.MReporting.Gui.MPersonnel' failed!
Solution: my working path had too many characters "C:\Documents and Settings\timotheusp\My Documents\openpetra\bzr\dev_0000159_exportimportgiftbatch". I renamed the branch part, and compilation works fine again!
Unit Testing
NUnit
Q: I get 'Assembly Not Loaded: System.BadImageFormatException' Exception
When starting NUnit on 64-bit Windows, you might get this error:
Assembly Not Loaded System.BadImageFormatException : Could not load file or assembly 'Tests.Common, Version=0.0.9.0, Culture=neutral, PublicKeyToken=null' or one of its dependencies. An attempt was made to load a program with an incorrect format. You may be attempting to load an assembly built with a later version of the CLR than the version under which NUnit is currently running (2.0.50727) or trying to load a 64-bit assembly into a 32-bit process.
Solution: run the nunit-x86.exe instead of the nunit.exe from your directory C:\Program Files (x86)\NUnit 2.5.8\bin\net-2.0 or similar.
Q: How can I include the sources of NUnit-Forms in my test software developement?
The standard unit tests of openpetra are handled by NUnit extended by NUnit-Forms. NUnit-Forms seems to be a project which has terminated some years ago and so it may be necessary to develop some own little extensions. In the very first level you can create a “development tool” combined by the NUnit-Forms-Sources and NUnit.
Actually the NUnit-Forms-dll is delivered inside the source tree and stored in the path \csharp\ThirdParty\NUnit.
Furthermore there exists a zip file which contains the our internal status of the NUnit-Forms sources. The zip-file can be unzipped anywhere else on the pc. Inside of the nunitforms\source-folder you’ll find the solution file NUnitForms.sln. Inside of this file you find the relevant project NUnitForms.
- Select this project, select “properties” and
- then select the tab “Compiling”
- then let the output path point to \csharp\ThirdParty\NUnit
- start a dll-build by using F8 (Sharp-Develop)
Then in case of an error not only the test routines are shown in NUnit but the other NUnitForms-Routines too. Of course, it is a something simple development suite because you cannot single step debug or something else. You only can use this static viewer and in the TextOutput-Tab you can place some messages using System.Console.Writeln.
Unable to Log in - Version Mismatch Message
Q: I have been running the IDE in debug mode against the client project. However, I am now unable to get past the OpenPetra Client login due to the following error:
OpenPetra Client/Server Program Version Mismatch! The Program Version of your OpenPetra Client (0.2.23.0) does not match the Program Version of the OpenPetra Server (0.22.10). An Open Petra Client cannot connect to an OpenPetra Server unless the Program versions match.
How do I avoid/fix this? Except for the original generate solution, I have made no intentional changes to this source and no compiles except for what debug itself does.
A: You had a PetraServer instance from the release version of OpenPetra (which you previously installed) running in the background. The PetraClient you have compiled from within the IDE has got a different version number than the PetraServer from the release, hence the PetraClient refuses to connect to that server. Solution: First kill the PetraServer.exe process from the release by using the Windows Task Manager, ensuring that there is no instance of it left in memory. Then start the PetraServer from your codebase by issuing 'nant startPetraServer' in a command window in your branch directory. Then press the 'Login' button again on the still running PetraClient instance that you are currently debugging. This will now go ahead as the PetraClient is now connecting to a compatible PetraServer version instance.
Unsorted questions
Q: I cannot find a string which is shown in a dialog, why?
Refering to this screen shoot you may search for a string like "ImportGL Transactions From Bank Statement" in order to find the piece of code responsible for that entry. The string you should look for is ImportGLTransactionsFromBankStatement, and this leads you directly to the file UINavigation.yml.
Q: I came across C# code like '... = @TServerLookup.TMCommon.GetData;' - what does it do, what is it for?
In the C# programming language the '@MethodName' notation is used for referencing the callee of a Delegate. The @ operator is optional, but it helps when 'scanning program code by eye' to identify such callees (and to find those quickly when using the find functionality of a code editor).
An example code line for that can be found in \csharp\ICT\Petra\Client\app\MainWindow\PetraClientMain.cs, Method 'InitialiseClasses':
TSharedValidationHelper.SharedGetDataDelegate = TServerLookup.TMCommon.GetData;
The code line means in English: ‘Set up the Delegate of Type TSharedGetData which is held in the static Field FDelegateSharedGetData in Class TSharedValidationHelper through its static Property SharedGetDataDelegate to point to the static Method TServerLookup.TMCommon.GetData’.
The purpose of setting this up is that the Method GetData in Ict.Petra.Shared.MCommon.Validation.TSharedValidationHelper (which is in a Project that can’t have a reference to any client-side projects as it is shared code that can be executed by both client and server) can still execute a client-side (or a server-side) method - although it is lacking Project References to those DLLs! 'What exactly' is getting executed at run time in Method GetData depends on whether the client or the server is setting up the SharedGetDataDelegate Delegate, and to which Method on ‘his side’ that points.
Note: The server-side set-up of the Delegate can be found in \csharp\ICT\Petra\Server\lib\CallForwarding\CallForwarding.cs, in the static Constructor of 'TCallForwarding'.
TSharedValidationHelper.SharedGetDataDelegate = @TCommonDataReader.GetData;
Q: What is the 'SiteKey' and how do I retrieve it?
Have a look here: Retrieving the 'SiteKey' of an OpenPetra installation.
More questions?
Just ask a question in this [Forum].