{"id":181,"date":"2019-11-01T12:52:15","date_gmt":"2019-11-01T12:52:15","guid":{"rendered":"https:\/\/sdf-docs.mansystems.com\/docs\/sdf-documentation\/ci-cd\/jobs\/"},"modified":"2022-05-17T09:24:38","modified_gmt":"2022-05-17T09:24:38","slug":"jobs","status":"publish","type":"docs","link":"https:\/\/sdf-docs.clevr.com\/?docs=ci-cd\/ci-cd\/jobs","title":{"rendered":"Jobs"},"content":{"rendered":"\n

The following jobs can be added in a pipeline:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

All jobs are simple and have few\nproperties.<\/p>\n\n\n\n

Shared properties<\/a><\/h3>\n\n\n\n

All jobs have an auto-description and a stop on fail property. Stop on fail means the next action in the pipeline is not executed if the previous one fails. <\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Actually only actions with special execution settings are still executed:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n

Mendix cloud<\/a> job<\/h3>\n\n\n\n

A Mendix cloud job does all the deployment activities for the Mendix cloud. The following actions are possible:<\/p>\n\n\n\n

\n Job<\/strong>\n <\/td>\n Description<\/strong>\n <\/td><\/tr>
\n Build deployment package\n <\/td>\n To build a deployment package from the latest commit of a branch\n Select branch\n <\/td><\/tr>
\n Clean\n <\/td>\n To clean the cloud slot (delete database, deployed package). Use with\n care!\n Select environment\n <\/td><\/tr>
\n Create backup\n <\/td>\n Creates a database backup for an environment\n Select environment\n <\/td><\/tr>
\n Create savepoint\n <\/td>\n Create a savepoint (database backup, deployment package, settings\n copy) for an environment\n Select environment\n <\/td><\/tr>
\n Restore backup\n <\/td>\n Restores a backup to an environment\n Select environmentSelect backup (after selecting environment!)\n \n Use case is to restore a specific backup for security or load tests\n <\/td><\/tr>
\n Restore savepoint\n <\/td>\n Restore the latest savepoint to an environment\n Select environment\n Use case is to restore a failed pipeline. You might want to check\n what the latest savepoint is in case multiple attempts have been done to run\n a pipeline\n <\/td><\/tr>
\n Set settings\n <\/td>\n Update the cloud slot settings (scheduled events, constants, runtime\n settings) with a locally stored set.\n Select environmentSelect locally saved and named settings (under app\n settings, tab Mendix cloud)\n \n <\/td><\/tr>
\n Start\n <\/td>\n Start environment\n Select environment\n <\/td><\/tr>
\n Stop\n <\/td>\n Stop environment\n Select environment\n <\/td><\/tr>
\n Synchronize\n <\/td>\n Sync environment status (running, deployed package), list of\n deployment packages, list of backups, list of revisions.\n This is often the first job in a pipeline for Mendix cloud jobs, so\n CI\/CD knows what the latest commit is.\n <\/td><\/tr>
\n Transport deployment\n <\/td>\n To transport a deployment from one cloud environment to the next.\n Select transport sourceLatest\n deployment packageOther\n environments deployment packageDeployment\n package created by other job in this pipelineSelect from environment (After transport source\n 2.)Select job (After transport source 3.)Select to environment\n \n \n \n \n \n \n <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

A savepoint stores a backup of the database,\nthe deployment package and all constants\/runtime settings\/scheduled event\nsettings. So a restore of a savepoint brings the environment in exactly the\nsituation as it was when the savepoint was created.<\/p>\n\n\n\n

For this reason the server is stopped\nfirst, so the backup is not taken with the application live.<\/p>\n\n\n\n

APM<\/a> job<\/h3>\n\n\n\n

APM defines API keys per environment, so\nthe API account already exactly defines which agent\/environment\/runtime is\nperforming the job.<\/p>\n\n\n\n

\n Job<\/strong>\n <\/td>\n Description<\/strong>\n <\/td><\/tr>
\n Snapshot reset\n <\/td>\n Clear statistics in APM agent\n <\/td><\/tr>
\n Snapshot create\n <\/td>\n Get manual statistics snapshot. Is used in code coverage.\n <\/td><\/tr>
\n Recording start\n <\/td>\n Start performance recording\n <\/td><\/tr>
\n Recording stop\n <\/td>\n Stop performance recording\n <\/td><\/tr>
\n Load test\n <\/td>\n Start a load test based on a named setup in APM Manager\/Load test\n setup. This setup includes all information for the test (script, data,\n environment, robots, duration, amounts)\n Name load test\n <\/td><\/tr>
\n Unit test\n <\/td>\n Start unit tests (on 1 runtime instance if multiple exist)<\/em>\n <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

For a unit test to be triggered you need an\nAPM agent (and thus also an APM license) and an extra module APMAgent2UnitTest\nthat is needed besides the AppStore Unittest module.<\/p>\n\n\n\n

To run a load test you must prepare a\nscript and setup and also have a baseline defined. This, so the load test\nexecuted during the pipeline can compare performance.<\/p>\n\n\n\n

Code coverage job<\/a><\/h3>\n\n\n\n

A typical code coverage job consists of the\nfollowing steps:<\/p>\n\n\n\n

  1. Reset counters<\/li>
  2. Run unit\/UI tests<\/li>
  3. Get APM snapshot with information on which microflows have run<\/li>
  4. Calculate code coverage in ACR and get number<\/li><\/ol>\n\n\n\n

    CI\/CD job<\/a><\/h3>\n\n\n\n

    To call a pipeline in another app. For example when implementing micro services, you can control the pipelines of multiple apps.<\/p>\n\n\n\n

    Steps:<\/p>\n\n\n\n

    1. Create pipeline in other app<\/li>
    2. Create API key in other app<\/li>
    3. Use [Send to CI\/CD API\naccount]:<\/li><\/ol>\n\n\n\n

      A dialog to select the other project is\nshown.<\/p>\n\n\n\n

      • Create CI\/CD job using:
        • API Account from 3<\/li><\/ul>
          • Pipeline from select dialog<\/li><\/ul><\/li><\/ul>\n\n\n\n

            When calling our CI\/CD from an external app you can find the pipeline guid on the API tab on the pipeline.<\/p>\n","protected":false},"featured_media":0,"parent":11,"menu_order":1,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-181","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/181"}],"collection":[{"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=181"}],"version-history":[{"count":3,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/181\/revisions"}],"predecessor-version":[{"id":2505,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/181\/revisions\/2505"}],"up":[{"embeddable":true,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/11"}],"next":[{"title":"New pipeline","link":"https:\/\/sdf-docs.clevr.com\/?docs=ci-cd\/ci-cd\/1-3-new-pipeline","href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/28"}],"wp:attachment":[{"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=181"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=181"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}