Heroku deploy (jhipster#561)

Deploy generated app in Heroku
Fix jhipster#389

Author: ivanmonteiro

docs/Features/heroku.md

@@ -1,38 +1,58 @@
-# Heroku Deploy
-This sub-generator initializes a Heroku [.Net 5](https://docs.microsoft.com/pt-br/dotnet/core/dotnet-five) app that is ready to push to Heroku.
+# Deploying to Heroku
+
+This sub-generator allows the deployment of your JHipster .Net application to Heroku cloud.
+
+The Heroku sub-generator will always use free tiers/options. Nevertheless installing addons needs a properly verified Heroku account. 
+
+Therefore to avoid any unexpected build failures, we would recommend verifying your Heroku account before starting this sub-generator.
 
 ## Pre-requisites
+
 Before running the sub-generator, you must install the [Heroku CLI](https://cli.heroku.com/).
-You must also create a Heroku account and run:
+
+Make sure that you are logged into Heroku.
 ```bash
 heroku login
 ```
+
 [Git](https://git-scm.com/) is also required to deploy to Heroku.
 
+Also make sure you have a working [Docker](https://docs.docker.com) installation (eg. `docker ps`) if deploying to Heroku Container Registry.
+
 ## Deploying to Heroku
-To deploy your .Net 5 application to Heroku, run this command:
+
+To deploy your application to Heroku, run the following command:
 
 ```bash
 jhipster heroku
-git push heroku main
 ```
 
-This will initialize a new Heroku app and git push your application to Heroku.
-Free tier dynos and database addons are used by the generator. A verified Heroku account might be needed to add some of the resources.
+## Databases
+
+- Mysql ✔
+- Postgres ✔ 
+- MSSQL ✔ (requires a manual step described below)
 
-This Heroku sub-generator is similar to its Java counterpart. Access the documentation at (https://www.jhipster.tech/heroku/). It might provide helpful insight. But keep in mind that there are some differences between both implementations of the Heroku sub-generator.
+Currently MySql and PostgreSQL database addons are free and automatically added by this sub-generator when deploying to Heroku. Even though those resouces are free, an accound with verified credit card is required to add them.
 
-## Databases
+Heroku's [MSSQL addon](https://elements.heroku.com/addons/mssql) is not free of cost and to avoid unexpected costs It will not be provisioned automatically when deploying to Heroku.
+
+Please visit [the MSSQL addon page](https://elements.heroku.com/addons/mssql), review the pricing and add the MSSQL addon to your account with the following command:
+```bash
+heroku addons:create mssql:REPLACE_PLAN_NAME --as DATABASE --app REPLACE_YOUR_APP_NAME
+```
 
-Currently MySql and PostgreSQL are supported and automatically added by the sub-generator when deploying to Heroku. [JawsDB MySQL addon](https://elements.heroku.com/addons/jawsdb) and [Heroku Postgres addon](https://elements.heroku.com/addons/heroku-postgresql) are added to the Heroku app using the free tier.
+## Oauth2
 
-Since the [MSSQL addon](https://elements.heroku.com/addons/mssql) is not free it requires manual provisioning. This sub-generator provides instructions on how to manually install the MSSQL addon.
+For applications that use Oauth2 the following manual steps are required:
 
-Heroku creates an environment variable named `DATABASE_URL` when using database addons. It contains the following structure: `dbType://user:password@server-url:db-port/db-name`. If `DATABASE_URL` is present the database credentials are parsed at `DatabaseConfiguration.cs` to create a properly formed connection string. And it takes precedence over existing connection strings.
+    1. Deploy the application to Heroku using `jhipster heroku`.
+    2. Access your (Heroku Dashboard)[https://dashboard.heroku.com/] and select the app you have just created.
+    3. Under `Installed add-ons` okta should be already installed.
+    4. Click on `okta` to open the addon's Dashboard.
+    5. To configure it follow the documentation (here)[https://jhipsternet.readthedocs.io/en/latest/Features/security.html#okta]
 
-**Notes:**
-The [heroku/nodejs buildpack](https://elements.heroku.com/buildpacks/heroku/heroku-buildpack-nodejs) is also added to the Heroku app. It is a pre-requisite to build Angular/React client applications.
 
-A `package.json` is automatically added to the root folder as It's required by the heroku/nodejs buildpack, otherwise the application deploy will fail.
+## Limitations
 
-[Jincod's Heroku .NET Core buildpack](https://github.com/jincod/dotnetcore-buildpack) is used to deploy this .Net 5 application to Heroku.
+Only monolithic deploys are supported at the moment.

generators/client/prompts.js

@@ -31,7 +31,7 @@ module.exports = {
 function askForClient() {
     if (this.existingProject) return;
 
-    var choices = [
+    const choices = [
         {
             value: ANGULAR,
             name: 'Angular',
@@ -53,7 +53,7 @@ function askForClient() {
             name: 'No client',
         },
     ];
-    
+
     if (this.configOptions.isDebugEnabled) {
         choices.push(
             {

generators/common/files.js

@@ -23,14 +23,25 @@ const files = {
         {
             templates: [{ file: 'Dockerfile-Back', renameTo: () => 'Dockerfile-Back' }],
         },
+        {
+            templates: [{ file: 'docker-entrypoint-back.sh', renameTo: () => 'docker-entrypoint-back.sh' }],
+        },
         {
             condition: generator => generator.clientFramework === constants.BLAZOR,
             templates: [{ file: 'Dockerfile-Front', renameTo: () => 'Dockerfile-Front' }],
         },
+        {
+            condition: generator => generator.clientFramework === constants.BLAZOR,
+            templates: [{ file: 'docker-entrypoint-front.sh', renameTo: () => 'docker-entrypoint-front.sh' }],
+        },
         {
             condition: generator => generator.clientFramework === constants.BLAZOR,
             templates: [{ file: 'nginx.conf', renameTo: () => 'nginx.conf' }],
         },
+        {
+            condition: generator => generator.clientFramework === constants.BLAZOR,
+            templates: [{ file: 'default.conf', renameTo: () => 'default.conf' }],
+        },
         {
             templates: [{ file: 'dockerignore', renameTo: () => '.dockerignore', method: 'copy' }],
         },

generators/common/templates/dotnetcore/Dockerfile-Back.ejs

@@ -23,10 +23,21 @@ RUN curl -sL https://deb.nodesource.com/setup_16.x | bash - && \
     apt-get install -yq nodejs && \
     rm -rf /var/lib/apt/lists/*
 
+<%_ if(!skipClient && clientFramework === "Blazor") { _%>
+# install blazor build tools only if INCLUDE_BLAZOR is set to true
+ARG INCLUDE_BLAZOR=false
+RUN if [ "$INCLUDE_BLAZOR" = "true" ]; then dotnet tool install -g Microsoft.Web.LibraryManager.Cli ; fi
+RUN if [ "$INCLUDE_BLAZOR" = "true" ]; then dotnet tool install -g Excubo.WebCompiler ; fi
+ENV PATH="${PATH}:/root/.dotnet/tools"
+<%_ } _%>
 # Restore dependencies of .net core projects taking advantage of docker layer caching
 COPY src/*/*.csproj ./src/
 COPY Directory.Build.targets Directory.Build.targets
 RUN for file in $(ls src/*.csproj); do mkdir -p ${file%.*} && mv $file ${file%.*}; done
+<%_ if(!skipClient && clientFramework === "Blazor") { _%>
+COPY src/client/*/*.csproj ./src/client/
+RUN for file in $(ls src/client/*.csproj); do mkdir -p ${file%.*} && mv $file ${file%.*}; done
+<%_ } _%>
 RUN dotnet restore "src/<%= mainProjectDir %>/<%= pascalizedBaseName %>.csproj"
 
 # Copy everything else and build app
@@ -36,10 +47,16 @@ RUN dotnet publish "<%= pascalizedBaseName %>.csproj" -c Release -o /app/out
 
 # Final stage/image
 FROM mcr.microsoft.com/dotnet/aspnet:6.0-focal AS runtime
-WORKDIR /app
 EXPOSE 80
+WORKDIR /app
+COPY docker-entrypoint-back.sh .
+RUN chmod +x /app/docker-entrypoint-back.sh
 COPY --from=build /app/out .
-
 ENV ASPNETCORE_ENVIRONMENT=Production
+<%_ if(!skipClient && clientFramework === "Blazor") { _%>
+ARG INCLUDE_BLAZOR
+ENV INCLUDE_BLAZOR $INCLUDE_BLAZOR
+ENV ServerUrl="https://localhost:8080"
+<%_ } _%>
 
-ENTRYPOINT ["dotnet", "<%= kebabCasedBaseName %>.dll"]
+ENTRYPOINT ["./docker-entrypoint-back.sh"]

generators/common/templates/dotnetcore/Dockerfile-Front.ejs

@@ -21,7 +21,9 @@ RUN dotnet publish "<%= pascalizedBaseName %>.Client.csproj" -c Release -o /app/
 
 FROM nginx:alpine AS final
 WORKDIR /usr/share/nginx/html
+ENV PORT 80
+ENV ServerUrl="https://localhost:8080"
 COPY --from=build /app/out/wwwroot .
-COPY ./nginx.conf /etc/nginx/nginx.conf
-ARG ServerUrl="https://localhost:8080"
-RUN sed -i "/ServerUrl/c\   "\"ServerUrl"\" : "\"$ServerUrl"\"," appsettings.json
+COPY ./nginx.conf /etc/nginx/
+COPY ./default.conf /etc/nginx/conf.d/
+COPY ./docker-entrypoint-front.sh /docker-entrypoint.d/

generators/common/templates/dotnetcore/README.md.ejs

@@ -28,11 +28,11 @@ This application was generated using JHipster <%= jhipsterVersion %> and JHipste
 
 Before you can build this project, you need to verify if [libman](https://github.com/aspnet/LibraryManager) and [webcompiler](https://github.com/excubo-ag/WebCompiler) are installed. (If the application is generated, the generator installed this tools for you)
 
-If not, run 
+If not, run
 
 ```bash
 dotnet tool install -g Microsoft.Web.LibraryManager.Cli
-dotnet tool install -g Excubo.WebCompiler 
+dotnet tool install -g Excubo.WebCompiler
 ```
 
 <%_ } _%>
@@ -54,11 +54,11 @@ dotnet run --verbosity normal --project ./src/client/<%= pascalizedBaseName %>.C
 
 You can also use the **hotreload**
 
-For the backend 
+For the backend
 ```bash
 dotnet watch --project ./src/<%= pascalizedBaseName %>/<%= pascalizedBaseName %>.csproj run --verbosity normal
 ```
-For the frontend 
+For the frontend
 ```bash
 dotnet watch --project ./src/client/<%= pascalizedBaseName %>.Client/<%= pascalizedBaseName %>.Client.csproj run --verbosity normal
 ```
@@ -167,9 +167,9 @@ In ClientApp folder run :
 
 <%_ } _%>
 
-### Generate entities 
+### Generate entities
 
-With cli 
+With cli
 ```bash
 jhipster entity <entity-name>
 ```
@@ -226,7 +226,7 @@ docker build -f ./Dockerfile-Back -t <%= baseName.toLowerCase() %> .
 <%_ if (!skipClient && clientFramework === "Blazor") { _%>
 
 ```bash
-docker build -f ./Dockerfile-Front -t <%= baseName.toLowerCase() %>-front . --build-arg ServerUrl=https://localhost:8080
+docker build -f ./Dockerfile-Front -t <%= baseName.toLowerCase() %>-front .
 ```
 
 <%_ } _%>
@@ -240,12 +240,12 @@ docker run -p 8080:80 <%= baseName.toLowerCase() %>
 <%_ if (!skipClient && clientFramework === "Blazor") { _%>
 
 ```bash
-docker run -p 8081:80 <%= baseName.toLowerCase() %>-front 
+docker run -p 8081:80 -e ServerUrl=https://localhost:8080 <%= baseName.toLowerCase() %>-front
 ```
 
 <%_ } _%>
 
-Or you can simply run : 
+Or you can simply run :
 
 ```bash
 docker-compose -f .\docker\app.yml build

generators/common/templates/dotnetcore/default.conf.ejs

@@ -0,0 +1,8 @@
+server {
+    listen 80;
+
+    location / {
+        root /usr/share/nginx/html;
+        try_files $uri $uri/ /index.html =404;
+    }
+}

generators/common/templates/dotnetcore/docker-entrypoint-back.sh.ejs

@@ -0,0 +1,33 @@
+<%#
+ Copyright 2019-2022 the original author or authors from the JHipster project.
+ This file is part of the JHipster project, see https://www.jhipster.tech/
+ for more information.
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+      http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-%>
+#!/bin/bash
+
+echo "Starting the application..."
+
+# if $PORT is set in the environment, set ASPNETCORE_URLS to "http://*:$PORT"
+if [ -n "$PORT" ]; then
+    echo "Setting ASPNETCORE_URLS with the PORT environment variable..."
+    export ASPNETCORE_URLS=http://*:$PORT
+    echo "ASPNETCORE_URLS: $ASPNETCORE_URLS"
+fi
+
+if [ "$INCLUDE_BLAZOR" = "true" ];  then
+    # replace blazor server url if INCLUDE_BLAZOR is true
+    echo "Replacing blazor server url in appsettings.json with the ServerUrl environment variable..."
+    sed -i "/ServerUrl/c\   "\"ServerUrl"\" : "\"$ServerUrl"\"," wwwroot/appsettings.json
+fi
+
+# run the dotnet app
+dotnet <%= pascalizedBaseName %>.dll

generators/common/templates/dotnetcore/docker-entrypoint-front.sh.ejs

@@ -0,0 +1,21 @@
+<%#
+ Copyright 2019-2022 the original author or authors from the JHipster project.
+ This file is part of the JHipster project, see https://www.jhipster.tech/
+ for more information.
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+      http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-%>
+#!/bin/sh
+
+echo "Replacing the backend/api in appsettings.json with the ServerUrl environment variable..."
+sed -i "/ServerUrl/c\   "\"ServerUrl"\" : "\"$ServerUrl"\"," appsettings.json
+
+echo "Replacing the listen port in default.conf with the PORT environment variable..."
+sed -i "s/listen.*/listen $PORT;/" /etc/nginx/conf.d/default.conf

generators/common/templates/dotnetcore/dockerignore.ejs

@@ -17,3 +17,4 @@ README.md
 sonar-project.properties
 **/node_modules
 **/Dockerfile
+**/ClientApp/target/