CET Developer is the primary CET development tool that strings together all the functions that a developer or quality assurance analyst would require when developing and/or testing. It hinds all the underlying complexity, and presents the user with an intuitive interface to help make the development process a lot more efficient and enjoyable.
This article briefly covers the various features and software that CET Developer comes bundled together with.
- EDevelopment environment (GitLab, Emacs etc) is automatically installed by Operator.
- GUI for creating/editing workspaces with just a few clicks.
Work safely in multiple workspaces simultaneously
- Environment variables are set up for your Emacs and other processes instead of globally. You can therefore run multiple Emacs instances, cmd-windows, work in different workspaces simultaneously and others.
- You can also set up your workspace to get core-files from a label of choice (beta-label, release-label etc) while still getting latest revision of other files.
Efficient Development Cycle
- Integration with Build Central for ease of building, monitoring, and publishing code.
- Troubleshooter that solves common problems with the environment.
- Button for starting CET Designer directly, without needing to manually compile/build from emacs.
Installing and setting up CET Developer
You can perform the following steps to have CET Developer up and running within minutes:
- Download and launch the CETDeveloper (msi).
- Click on “Download and Install All”. CET Developer will then proceed with downloading and installing all the required programs.
- Input your MyConfigura account e-mail and password.
- Click on Log in.
- Set your GitLab server.
- Input your GitLab account username and password.
- Click on Log in.
- Click on Continue.
Classification of features
The software is well-divided into several distinct categories as shown in the screenshot below. Items in sections 2, 3, 4, and 5 are dependent on the selected workspace in section 1, meaning each workspace can have its own set of settings.
- Workspace View
- Source Control Tools
- CET Designer Tools
- Developer Tools
- Workspace Tools
1. Workspace View
A workspace essentially is a local copy of files and folders retrieved from the server. You can make changes to the files in your workspace, run some tests on it and then decide if your changes should be submitted to the server or not. It's quite common to have more than one workspace set-up on CET Developer.
A regular workspace can be used with all features except "Continuous Build". You will want to use a regular workspace to develop and submit code.
A build workspace is used as a read-only workspace (with the exception that you can change version numbers), where you select a submitted changelist number and then build your extensions from that revision. The benefit of that is that you then know that the built extensions correspond to the code submitted at that changelist and does not contain any unsubmitted changes. A build workspace also allows better traceability when building extensions for release as compared to a regular workspace.
Creating and editing a workspace
To create a regular workspace, perform the following steps:
- In Operator, click "Add Git workspace"
- Select Core branch/version
- Select which custom folder to include.
- (Optional) In Workspace settings, "Workspace Name" box, you can type in a name that you would associate to the workspace. This is particularly useful if you need to have more than one workspace of the same version. (e.g. if your workspace is "user-machine-version11.0” and you want to create a separate one for releases, you can set the suffix to “release” and the name will be “user-machine-version11.0-release”.)
- (Optional) Change the default location of workspace by picking a local folder. Default is set to C\CetDev".
- Click Save.
A build workspace is created the same way as a regular workspace, but with the inclusion of checking the “Use for Build” checkbox which is found in the workspace creator. A required name-suffix “_build” will be automatically added to the workspace as opposed to a regular workspace.
2. Source Control Tools
It is, of course, necessary to have a good system in place to facilitate version control. At Configura, our preferred version control software is GitLab, which is closely tied to workspaces in CET Developer. File changes in workspaces are tracked and handled by CET Developer.
3. CET Designer Tools
The CET Designer tools tab allows the user to set the version of CET Designer (32-bit/64-bit), launch CET Designer, repair their workspace, and also quickly access file paths that are relevant to the selected workspace.
Switching between 32-bit and 64-bit
You can start different architecture versions of the CET Designer by switching between the 32-bit and 64-bit button.
Starts an instance of CET Designer from the selected workspace. It does this by starting a _cm-instance that executes the “robustStartDesigner”-method (in develop-mode).
Solves common problems that can occur with your environment by clearing the write folder. For example, a corrupted file that resides in the write folder could prevent CET Designer from booting up.
The File Paths dialog gives you shortcuts to essential file locations for your workspace, CET Designer and CET Developer.
4. Developer Tools
This section consists of a collection of great software that you will find yourself using very frequently throughout the development cycle.
|Emacs is an advanced, highly-configurable text-editor. The emacs software that is bundled together with CET Developer has been configured to work seamlessly with Configura Magic (CM). You can further customise Emacs to suit your workflow.
Clicking on the Emacs icon will start an instance of emacs for the selected workspace. It is possible to have multiple emacs instances running for different workspaces. For example, you could have one for 10.5 and another for 11.0 running at the same time.
Switch to Visual Emacs Mode - If you are not a fan of Emacs shortcuts, and would like to use more Windows-esque shortcuts, you can give Visual Emacs a shot. It comes with a set of graphical elements that you can interact with to run certain commands, unlike the regular version of Emacs.
Start new Emacs instance - Multiple Emacs instances can also be launched for the same workspace by clicking on “Start new Emacs instance”.
Emacs settings - Launches the Emacs settings dialog, in which you can configure your font types, font sizes, window split options, files to open on load and so on. You can also write your own Emacs shortcuts, and have them added to the list of additional keybindings here.
Starts a cmd-window for the selected workspace. In the same way as for the “Launch Emacs”-command, it works by setting up workspace-specific environment-variables (CM_HOME etc) for the specific process. This eliminates the need for setting the global environment variables and allows working with different workspaces simultaneously as the different processes have different sets of environment variables. This launches it with Administrator rights which will allow you to access files that requires access permissions.
Launches a dialog in which you can search in all file formats (.cm, .rs, .cpp, .m etc). This is in addition to the existing TAG search which only operates with the .cm format. This is a brilliant way to get an overview of the locations in which a particular string is used, and so on.
Build Central is used for building extensions and monitoring submitted code by performing continuous builds.
Launches the Test Assistant dialog that allows you to view crash reports collected by the Test Assistant, and starts CET Designer in Test mode for the selected workspace. Test Assistant makes CET Designer run automatically, randomly navigating and using all kinds of features of the program until it crashes. It then restarts the program and continues until it crashes again and so on.
5. Workspace Tools
You may, at times, find yourself wanting to add/remove code from paths that weren't checked during the initial process of creating a workspace. You can use the this to handle situations of this sort. When you are done making your changes, CET Developer will add/remove files to/from your workspace.
Clicking on the delete button removes the workspace from the server and from your local drive.
When a workspace is set to be offline, CET Developer will not perform any Perforce-commands on it. You can then move its folder safely to another location. When you want to use it again, you can move the folder back and set it online.
In your Oprator Environment Setup, make sure you are logged into MyConfigura and set your Git and Jira server.