hmrc / init-service

init-service

A python library to initialise a repository.

This library,

• clones an existing repository
• adds the Play project with up to date dependencies
• commits and pushes the changes to Github

Run init-service --help for instructions.

Prerequisites

This library requires,

• Python 3.9
• the $WORKSPACE environment variable to be set - new repositories will be created in this directory
• a github token with permissions to push to the repository that needs initialising

Additional development dependencies

• poetry ( pip install poetry )

To install the dependencies run: make init

Or if you have nix installed, you can just run nix-shell

Installation

pip install -i https://artefacts.tax.service.gov.uk/artifactory/api/pypi/pips/simple init-service

Example usage

Create a frontend microservice like this: init-service my-frontend-microservice FRONTEND --github-token <token>

Create a backend microservice like this: init-service my-backend-microservice BACKEND --with-mongo --github-token <token>

Running the tests

In order to run the tests you will need pytest installed.

To run the tests run: make test

Manually testing a new repository

You can generate a repository for inspection with: init-service <repository-name> <type> --dry-run

The new repository will be created in $WORKSPACE/

You will then need to manually copy over the repository.yaml and LICENSE file (public repositories only) from another HMRC repository.

For example,

init-service test-frontend FRONTEND
cp ../contact-frontend/LICENSE ../test-frontend
cp ../contact-frontend/repository.yaml ../test-frontend
cd ../test-frontend
sbt run

Then navigate to http://localhost:9000/test-frontend

Adding a file specific to a backend or a frontend

If you need to add a file that should only exist in a frontend or backend, but not both, add the path to the file to templates/service/template/BACKEND.delete if frontend-specific or templates/service/template/FRONTEND.delete if backend-specific.

Publishing a new version

Increment the version found in pyproject.toml and run:

make publish

init-service's Issues

Default versions in templates are behind platform

Upon creating a new service using a template, the project shows minor versions out of date with sbt validate
SBT version is also a minor version behind the supported platform version

Generate Test Scaffolding?

Just a quick question/suggestion on this - is it/can we make it so that it also scaffolds tests for the generated code? It would be fantastically useful to have some template tests as well as the controller, etc.

Front-end templates have invalid content before the doctype

There are 36 mostly blank lines being generated before the doctype declaration includng 3 ')' so ))) is getting rendered before the header in the browser.

Enhance MicroserviceController scaffolding

Just a few suggestions to improve the scaffolding when you create a new service.

When you generate your new microservice using the script it the controller generates is called "MicroserviceHelloWorld". It might be good to use name conventions, e.g. "HelloWorldController" or "${ProjectName}HelloWorldController".

Scaffolding the folder structure (assets, controllers,connectors, services) might also be useful.

Within the controller there is also only 1 method to answer a "get" with hello world. Perhaps expanding this to have scaffolding for all the RESTful api calls would be nice as well.

Finally, is there a way to scaffold an authenticated controller vs a public controller, so that when starting out the auth requirements are baked in with specified Enrollments?

Default Header link to http://www.google.com is inappropriate

The following code supplied a default Nav link which sends users to http://www.google.co.uk/ https://github.com/hmrc/init-service/blob/master/templates/service/app/views/govuk_wrapper.scala.html#L23-L26

We shouldn't supply an off platform Default Home link as there's a risk this might get left in place rather than overridden as intended.

@gavinwye believes that it shouldn't supply any markup by default.

sbt idea generates out of date project config / import from sbt fails

When using sbt idea and then opening the project in Idea 2016.1.3 error messages are as shown. Given sbt support in Idea now, should this be removed?

When importing the sbt project within idea it does work ok after configuring the scala sdk to be used in with the project then rebuilding and restarting - otherwise it was not recognizing play libraries, which I suppose is configuration my end since the project files remain unchanged.

Hardcoded assets-frontend version is out of date

The version of assets-frontend that's hard coded here is out of date.

Rather than it being hard coded and having to update it in the service every time one's been created, could it be made dynamic? it could pull the latest version from somewhere at run time.