Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/isc-rsingh/intersystems-iris-dev-template
https://github.com/isc-rsingh/intersystems-iris-dev-template
Last synced: 19 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/isc-rsingh/intersystems-iris-dev-template
- Owner: isc-rsingh
- License: mit
- Created: 2022-05-02T19:37:43.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-05-02T19:37:44.000Z (over 2 years ago)
- Last Synced: 2024-11-08T14:57:05.702Z (2 months ago)
- Language: ObjectScript
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://openexchange.intersystems.com/package/intersystems-iris-dev-template)
[](https://community.objectscriptquality.com/dashboard?id=intersystems_iris_community%2Fintersystems-iris-dev-template)
[](https://community.objectscriptquality.com/dashboard?id=intersystems_iris_community%2Fintersystems-iris-dev-template)
[](LICENSE)
# intersystems-iris-dev-template
This is a basic template for a development environment to work with ObjectScript in InterSystems IRIS. It helps you edit, compile, commit/push, debug and test your ObjectScript code. It also aids in packaging your application as a module installable with ZPM.
## Description
This repository provides a read-to-go development environment for coding productively with InterSystems ObjectScript. This template:
* Runs InterSystems IRIS Community Edition in a docker container
* Creates a new namespace and database IRISAPP
* Loads the ObjectScript code into IRISAPP database using Package Manager
* Promotes development with the 'Package First' paradigm. [Watch the video](https://www.youtube.com/watch?v=havPyPbUj1I)
* Provides a unit testing environment: sample unit tests, tests module enablement
## Usage
Start a new dev repository with InterSystems IRIS using this one as a template.
Once you clone the new repo to your laptop and open VSCode (with the [InterSystems ObjectScript Extension Pack](https://marketplace.visualstudio.com/items?itemName=intersystems-community.objectscript-pack) installed) you'll be able to start development immediately.
## Prerequisites
Make sure you have [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [Docker desktop](https://www.docker.com/products/docker-desktop) installed.
## Installation
Clone/git pull the repo into any local directory
```
$ git clone https://github.com/intersystems-community/intersystems-iris-dev-template.git
```
Open the terminal in this directory and call the command to build and run InterSystems IRIS in container:
```
$ docker-compose up -d
```
To open IRIS Terminal do:
```
$ docker-compose exec iris iris session iris -U IRISAPP
IRISAPP>
```
To exit the terminal, do any of the following:
```
Enter HALT or H (not case-sensitive)
```
## What does it do
THe sample repository contains two simplest examples of ObjectScript classes: ObjectScript method that returns value and method that creates a persistent record.
1. Open IRIS terminal and run the ObjectScript Test() method to see if runs the script and returns values from IRIS:
```
$ docker-compose exec iris iris session iris -U IRISAPP
IRISAPP>write ##class(dc.sample.ObjectScript).Test()
It works!
42
```
2. Class `dc.sample.PersistentClass` contains a method `CreateRecord` that creates an object with one property, `Test`, and returns its id.
Open IRIS terminal and run:
```
IRISAPP>write ##class(dc.sample.PersistentClass).CreateRecord(.id)
1
IRISAPP>write id
1
```
In your case the value of id could be different. And it will be different with every call of the method.
You can check whether the record exists and try to right the property of the object by its id.
```
IRISAPP>write ##class(dc.sample.PersistentClass).ReadProperty(id)
Test string
```
## How to start the development
This repository is ready to code in VSCode with the ObjectScript plugin.
Install [VSCode](https://code.visualstudio.com/), [Docker](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) and the [InterSystems ObjectScript Extension Pack](https://marketplace.visualstudio.com/items?itemName=intersystems-community.objectscript-pack) plugin and open the folder in VSCode.
Open the `/src/cls/PackageSample/ObjectScript.cls` class and make changes - it will be compiled in the running IRIS docker container.
Feel free to delete the PackageSample folder and place your ObjectScript classes in the form
`/src/organisation/package/Classname.cls`
[Read more about folder setup for InterSystems ObjectScript](https://community.intersystems.com/post/simplified-objectscript-source-folder-structure-package-manager) and here on the [naming convention](https://community.intersystems.com/post/naming-convention-objectscript-packages-classes-and-package-manager-modules-names)
## Running unit tests
The template contains two test classes: `TestObjectScript.cls` and `TestPersistentClass.cls `
To run the unit tests we can use the Package Manager environment.
```
IRISAPP>zpm
=============================================================================
|| Welcome to the Package Manager Shell (ZPM). ||
|| Enter q/quit to exit the shell. Enter ?/help to view available commands ||
=============================================================================
zpm:IRISAPP>load /irisrun/repo
[dc-sample-template] Reload START (/irisrun/repo/)
[dc-sample-template] Reload SUCCESS
[dc-sample-template] Module object refreshed.
[dc-sample-template] Validate START
[dc-sample-template] Validate SUCCESS
[dc-sample-template] Compile START
[dc-sample-template] Compile SUCCESS
[dc-sample-template] Activate START
[dc-sample-template] Configure START
[dc-sample-template] Configure SUCCESS
[dc-sample-template] MakeDeployed START
[dc-sample-template] MakeDeployed SUCCESS
[dc-sample-template] Activate SUCCESS
zpm:IRISAPP>test dc-sample-template
[dc-sample-template] Reload START (/irisrun/repo/)
[dc-sample-template] Reload SUCCESS
[dc-sample-template] Module object refreshed.
[dc-sample-template] Validate START
[dc-sample-template] Validate SUCCESS
[dc-sample-template] Compile START
[dc-sample-template] Compile SUCCESS
[dc-sample-template] Activate START
[dc-sample-template] Configure START
[dc-sample-template] Configure SUCCESS
[dc-sample-template] MakeDeployed START
[dc-sample-template] MakeDeployed SUCCESS
[dc-sample-template] Activate SUCCESS
[dc-sample-template] Test STARTIt works!
Use the following URL to view the result:
http://172.28.0.2:52773/csp/sys/%25UnitTest.Portal.Indices.cls?Index=1&$NAMESPACE=IRISAPP
All PASSED
[dc-sample-template] Test SUCCESS
zpm:IRISAPP>
```
In case of test errors, you can find more details back in the UnitTest portal, which can be easily opened via ObjectScript menu in VSCode:
## What else is inside the repository
### .github folder
Contains two GitHub actions workflows:
1. `github-registry.yml`
Once changes pushed to the repo, the action builds the docker image on Github side and pushes the image to Github registry that can be very convenient to further cloud deployement, e.g. kubernetes.
2. `objectscript-qaulity.yml`
with every push to master or main branch the workflow launches the repo test on objectscript issues with Objectscript Quality tool, [see the examples](https://community.objectscriptquality.com/projects?sort=-analysis_date). This works if the repo is open-source only.
Both workflows are repo agnostic: so they work with any repository where they exist.
### .vscode folder
Contains two files to setup vscode environment:
#### .vscode/settings.json
Settings file to let you immediately code in VSCode with [VSCode ObjectScript plugin](https://marketplace.visualstudio.com/items?itemName=daimor.vscode-objectscript))
#### .vscode/launch.json
Config file if you want to debug with VSCode ObjectScript
### src folder
Contains source files.
src/iris contains InterSystems IRIS Objectscript code
### tests folder
Contains unit tests for the ObjectScript classes
### dev.md
Contains a set of useful commands that will help during the development
### docker-compose.yml
A docker engine helper file to manage images building and rule ports mapping an the host to container folders(volumes) mapping
### Dockerfile
The simplest dockerfile which starts IRIS and imports code from /src folder into it.
Use the related docker-compose.yml to easily setup additional parametes like port number and where you map keys and host folders.
### iris.script
Contains objectscript commands that are feeded to iris during the image building
### module.xml
IPM Module's description of the code in the repository.
It describes what is loaded with the method, how it is being tested and what apps neeed to be created, what files need to be copied.
[Read about all the files in this artilce](https://community.intersystems.com/post/dockerfile-and-friends-or-how-run-and-collaborate-objectscript-projects-intersystems-iris)