undefined undefined Sun, 08 Sep 2024 22:54:51 GMT https://validator.w3.org/feed/docs/rss2.html Joplin Pages Publisher <![CDATA[SonarCloud]]> 6ce014eb577949b2ba2702f0b88ce343 Fri, 25 Dec 2020 19:11:13 GMT SonarCloud integration

This article as a reminder on how to integrate your project into SonarCloud.

https://sonarcloud.io/projects

Maven

In the pom.xml add:

    <properties>         
        <sonar.projectKey>blablanumerodeux_kayak</sonar.projectKey>
        <sonar.organization>blablanumerodeux</sonar.organization>
        <sonar.host.url>https://sonarcloud.io</sonar.host.url>
<!--        this should not be committed-->
        <sonar.login>d0d909736d1c196a530e6f3f26e62bee1a81cd7f</sonar.login>
    </properties>

Use this maven command only if you're the only dev in the team, otherwise you may override the scan of others:

mvnw verify sonar:sonar -DskipTests -f pom.xml

NB

you can also specify these params from the mvn command line that will be launched by jenkins for example -> see below at the end

CircleCi

If you're not alone on your project, then set your token within an environment variable called :
SONAR_TOKEN

https://www.baeldung.com/sonar-qube

https://docs.sonarqube.org/latest/analysis/gitlab-cicd/

Also SONAR_HOST_URL can also be set as an environment variable.

Finally, here is another example of maven command that you can use within your circleci config file:

mvnw source:jar javadoc:jar install -DcreateChecksum=true -e sonar:sonar

Also, don't forget to include your environment variables (via the context features) with your workflows on your circleci config file like such:

  
workflows:  
  version: 2  
  
  just-build:  
    jobs:  
      - build:  
          context: SonarCloud

More doc on how the sonar maven plugin works

https://stackoverflow.com/questions/14979530/why-does-the-maven-command-mvn-sonarsonar-work-without-any-plugin-configurati

https://blog.sonarsource.com/we-had-a-dream-mvn-sonarsonar/

IntelliJ IDEA plugins

SonarLint

Go on your SonarCloud profile and generate a new token.
Use it to connect to SonarCloud with SonarLint so that your SonarCloud connection within SonarLint will have access to all your organisations and repo.
So that you won't need to regernate 1 token per repo.

Then "Update binding".
Done.
then Ctrl-Shift-S to analyse a specific file. Also more options are available in the SonalLint Bar (at the bottom) or in the Analyze menu.

SonarQube

Configure your SonarCloud account on the IntelliJ IDEA params.
Then Analyze menu -> Inspect code (Ctrl-Alt-Shift-I) -> inspection profile Sonar -> ok.

Done

NB: use this plugin only if you're alone on the project.
Otherwise you may override the scan of others

Project badge

Once you sent your project to SonarCloud, on the right bottom corner you can generate your badge and paste it on your README.md file.

example of a badge:

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=dans-la-rue_homeless&metric=alert_status)](https://sonarcloud.io/dashboard?id=dans-la-rue_homeless)

Jenkins with maven

Jenkinsfile

//                               sh 'mvn org.sonarsource.scanner.maven:sonar-maven-plugin:3.7.0.1746:sonar \
  sh """./mvnw sonar:sonar \
                  -Dsonar.host.url=${codeQualityManagementConfig.api_url} \
                  -Dsonar.projectKey=${sonarProjectName} \
                  -Dsonar.projectName=${sonarProjectName} \
                  -Dsonar.login=${bncSonarCredentials.credentials.username} \
                  -Dsonar.password=${bncSonarCredentials.credentials.password} \
                  -Dsonar.branch.name=${env.BRANCH_NAME} \
                  """
//                                               -Dsonar.branch.target=${targetBranch}"""

add those for sonar to differenciate the tests from the src

sonar-project.properties

sonar.sources=./src/main/java
sonar.tests=./src/test/java

or sonarqube with jacoco for test coverage

utils.shWithNoTrace """./mvnw sonar:sonar \
      -Dsonar.host.url=${codeQualityManagementConfig.api_url} \
      -Dsonar.projectKey=${sonarProjectName} \
      -Dsonar.projectName=${sonarProjectName} \
      -Dsonar.login=${bncSonarCredentials.credentials.username} \
      -Dsonar.password=${bncSonarCredentials.credentials.password} \
      -Dsonar.branch.name=${env.BRANCH_NAME} \
      -Dsonar.coverage.jacoco.xmlReportPaths=target/jacoco.exec \
      """
//                                               -Dsonar.branch.target=${targetBranch}"""

//                             }

https://docs.sonarqube.org/pages/viewpage.action?pageId=1442166

]]> <![CDATA[gh-pages]]> 672be4ec486c4a599e1f5b5b1d989e8f Fri, 25 Dec 2020 19:11:13 GMT Host your angular app on github

CNAME record

On your domain provider, create a new CNAME record such as:
dakar.project.lambla.eu.-> dakarinternational.github.io.

In your src folder create a CNAME file and write your custom domain in it.
then, inside angular.json file add this line:

"assets": [  
"src/favicon.ico",  
"src/assets",  
"src/CNAME" // This is the change you need to make.  
],

https://github.com/tschaub/gh-pages/issues/236

Angular build

npm run ng build -- --prod --base-href "https://dakarinternational.github.io/DaKar-ngFront/"

or more important if you want to use your domain:

npm run ng build -- --prod --base-href "https://dakar.project.lambla.eu/"

otherwise you may have:

Mixed Content: The page at ‘<your_gpages_remote_url>’ was loaded over HTTPS, but requested an insecure stylesheet ‘<url_provided_with_http_prefix_while_deploying>/styles.acb808cb000123f5c6ec.css'. This request has been blocked; the content must be served over HTTPS.

Angular CLI deploy

npx ngh --dir=dist/DaKar-ngFront  
or  
npx angular-cli-ghpages --dir=dist/homeless-front

https://medium.com/tech-insights/how-to-deploy-angular-apps-to-github-pages-gh-pages-896c4e10f9b4

Github pages config

https://github.com/DaKarInternational/DaKar-ngFront/settings

in Settings -> Options -> Github Pages :
put your custom domain such as : dakar.project.lambla.eu
enforce https.
done

Github Actions setup

1.  First login to [https://github.com](https://github.com)
2.  Go to [https://github.com/setting/profile](https://github.com/setting/profile)
3.  Now click on to the `Developer settings`
4.  Click on `Personal access tokens` and generate a token
5. 1.  Go to your repository `Settings`
6.  Click on `Secrets`
7.  Click on `Add new secret`
8.  Put `ACCESS_TOKEN` for name and `your github token that you had copy` as value. Now click on `Add secret` button. A secret with name `ACCESS_TOKEN` is saved in your repository.
9. in your repository's `Action` tab, set up workflow using these code

main.yaml
name: CI

on: [push]

jobs:
  build:

    runs-on: ubuntu-18.04
    steps:
    - uses: actions/checkout@v1
    - name: Use Node.js 8.15.1
      uses: actions/setup-node@v1
      with:
        node-version: 8.15.1
    - name: Build and Deploy
      uses: JamesIves/github-pages-deploy-action@releases/v2
      env:
        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
        BASE_BRANCH: develop
        BRANCH: gh-pages
        FOLDER: dist/homeless-front
        BUILD_SCRIPT: npm install && npm run ng build -- --prod --base-href "https://homeless.project.lambla.eu/"

https://uxworks.org/how-to-deploy-angular-app-on-github-pages-using-github-actions

Sources

https://angular.io/guide/deployment

https://dev.to/apdharshi/deploying-your-angular-application-to-github-pages-4laf

https://help.github.com/en/github/working-with-github-pages/securing-your-github-pages-site-with-https

Other things to explore:

https://www.codementor.io/@landonpatmore/how-to-setup-a-static-website-using-github-pages-and-cloudflare-with-your-own-domain-name-jb99nbuoe

https://hackernoon.com/set-up-ssl-on-github-pages-with-custom-domains-for-free-a576bdf51bc

]]> <![CDATA[JFrog Bintray]]> 2741b8d51fba4d618750d2be995856f0 Fri, 25 Dec 2020 19:11:13 GMT

title: "Maven deploy to OSS JFrog to Maven Central"
date: 2019-11-10T20:53:32-04:00
draft: false

Maven deploy to OSS JFrog to Maven Central

JFrog BinTray

Begin by creating an organisation and a package on JFrog BinTray.
Edit your package and request that your package be added to JCenter
Don't forgot to tick the option : Host my snapshot build artifacts on the OSS Artifactory
Wait for your request to be granted.

Then, Edit your profile and find your API key.

OSS JFrog

Use that key as your password to connect in OSS-JFrog.
Use your BinTray profile name as your username to connect in OSS-JFrog.

Maven

Then in your pom.xml add this directly under <project>:

    <!--this to push directly a release into bintray, does not work for snapshot though-->
<!--	<distributionManagement>
        <repository>
            <id>bintray-blablanumerodeux-dakar</id>
            <name>blablanumerodeux-dakar</name>
            <url>https://api.bintray.com/maven/dakarinternational/dakar/dakar/;publish=1</url>
        </repository>
    </distributionManagement>-->

    <!--this to push to OSS -->
    <distributionManagement>
        <repository>
            <id>central</id>
            <name>oss-jfrog-artifactory-releases</name>
            <url>https://oss.jfrog.org/artifactory/oss-release-local</url>
        </repository>
        <snapshotRepository>
            <id>snapshots</id>
            <name>oss-jfrog-artifactory-snapshots</name>
            <url>https://oss.jfrog.org/artifactory/oss-snapshot-local</url>
        </snapshotRepository>
    </distributionManagement>

please note the <id>central</id> and <id>snapshots</id>, we'll use these below.

also be sure to configure correctly this part :

    <groupId>dans-la-rue</groupId>
    <artifactId>homeless</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

Now that your project is configured, go in your settings.xml file which should be somewhere here: ~/.m2/settings.xml
And make sure to add the servers config like that:

<?xml version='1.0' encoding='UTF-8'?>
<settings xsi:schemaLocation='http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd'
         xmlns='http://maven.apache.org/SETTINGS/1.0.0' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
   <servers>
       <server>
           <id>bintray-blablanumerodeux-dakar</id>
           <username>blablanumerodeux</username>
           <password>${env.BINTRAY_API_KEY}</password>
       </server>
       <server>
           <id>central</id>
           <username>blablanumerodeux</username>
           <password>${env.JFROG_API_KEY}</password>
       </server>
       <server>
           <id>snapshots</id>
           <username>blablanumerodeux</username>
           <password>${env.JFROG_API_KEY}</password>
       </server>
   </servers>
</settings>

Note again the <id>central</id> and <id>snapshots</id> that match the one above.

Then you can deploy your SNAPSHOT or RELEASE with maven: mvn clean source:jar javadoc:jar deploy -DskipTests -DcreateChecksum=true

If you want to publish your package into the Maven Central repo, then you need to make sure that your java source files are inside your JAR file.
To do that you can configure your maven build with the <resources> tag like that:

    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.java</include>
                </includes>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>3.0.1</version>
                <configuration>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>2.3.2</version>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <version>2.1.2</version>
            </plugin>
        </plugins>
    </build>

Glossary

  • OJO: Oss.Jfrog.Org
  • OSS: Open Source Solutions from JFrog
  • BinTray: Website used to manage users, organisations, repos,packages,versions,and promot versions to JCenter and Maven Central
  • JCenter: One of the public repo where you can host freely your open source software
  • Maven Central: The most famous public repo to host freely your open source software
  • Artifactory: One of the 3 main repository management tool (Sonartype Nexus, JFrog Artifactory, and NPM)
]]> <![CDATA[deploy]]> 3762b108b599481280ce8c10729656fe Fri, 25 Dec 2020 19:11:13 GMT

title: "HUGO"
date: 2019-10-17T20:53:32-04:00
draft: false

HUGO

create a new site

hugo new site me

install theme

go here minimal and follow the instructions:

git submodule add https://github.com/calintat/minimal.git themes/minimal
git submodule init
git submodule update
git submodule update --remote themes/minimal
cp themes/minimal/exampleSite/config.toml

in the file config.toml set all your params, and:

baseurl = "http://examplesite" <- Change to https://yourgithubusername.github.io

push on your github

On branch master you have the public folder (built version)
And on the hugo branch you put the hugo project

Checkout the hugo branch

hugo serve -> to test localy
hugo -d ../blablanumerodeux.github.io/ -> to build the static version in the folder blablanumerodeux.github.io

blablanumerodeux.github.io folder is used to push the public folder (wich contains the static version of the website) without the hugo files (we could have make 2 different repos and a submodule)

git push origin master -u
git push origin hugo -u

some good themes:

https://themes.gohugo.io/hugo-coder/
https://themes.gohugo.io/minimal/

sources:

https://dev.to/michalbryxi/simplify-pushing-to-git-32g6
https://dev.to/dgavlock/creating-a-hugo-site-on-github-pages-3cjo
https://themes.gohugo.io/minimal/
https://github.com/calintat/minimal/
https://gohugo.io/hosting-and-deployment/hosting-on-github/
https://gohugo.io/hosting-and-deployment/hosting-on-github/#use-a-custom-domain
https://themes.gohugo.io//theme/minimal/post/

circleci git

circleci ssh key

hugo docker image

inspiration

https://tomlicha.github.io/
https://github.com/tomlicha/tomlicha.github.io

]]> <![CDATA[properties files and secrets managers]]> 9f2c5bcec3144c96a5fc588fe2bc8021 Fri, 25 Dec 2020 19:11:13 GMT

title: "Secrets and properties management"
date: 2019-10-17T20:53:32-04:00
draft: false

Secrets and properties management

Properties files with Spring boot

Specify different profiles (for the different DB for example) like this in the default application.properties file:

spring.profiles.active=local

or at runtime like that:

java -Dspring.profiles.active=local -jar yourApplication.jar

please note the -D params are set BEFORE the -jar

It will automatically take the corresponding properties file in the classpath application-local.propertie

Secrets with Spring boot

When you have to specify a secret, just define a placeholder instead:

spring.datasource.password=${db-password}

and pass the value at runtime with a Java -D variable:

-Ddb-password=example

Or you can also externalize your config folder or just a properties file:
Spring Properties File Outside jar
and also pass the locations at runtime with an environment variable or just a java -D variable.

Environment and Java variables

Problem is how to pass the environment variables or the java -D variables when your jar is embeded inside a docker image ?

Dockerfile

#https://docs.docker.com/engine/reference/builder/#using-arg-variables  
FROM openjdk:8-jdk-alpine  
ARG JAR_FILE  
ADD ${JAR_FILE} app.jar  
ENTRYPOINT ["java", "-jar", "-Dspring.profiles.active=${PROFILE}", "/app.jar"]

${PROFILE} is referencing an environment variable that will be resolved at the runtime only, not during the build time.

${JAR_FILE} is referencing an argument passed within the docker build command (launched from docker-compose or maven). This variable is not used anymore after the build is done.

more info on the env variables here

Docker-compose

app:  
  image: "dakarinternational/dakar:latest"  
  env_file: .env  
  build:  
    dockerfile: Dockerfile  
    context: .  
    args:  
      JAR_FILE: $JAR_FILE  
  ports:  
   - "8080:8080"  
  container_name: 'app-dakar'  
  depends_on:  
   - "couch"

Here is the .env file:

PROFILE=prod  
JAR_FILE=target/dakar-0.0.3.jar

NB: Please note that the JAR_FILE could (and should) be put directly in the args section.
No need for such an environment variable just for the build time, it's here just to demonstrate how we can use env variables within the docker-compose file.

Another way to do the same thing is like this:

  app:  
    image: "danslarue/homeless:latest"  
  build: .  
  ports:  
    - "9090:8080"  
  container_name: 'app-homeless'  
  environment:  
    - db-password=example

Note the environment part

Maven

Here is the config for the docker plugin:

            <plugin>
                <groupId>com.spotify</groupId>
                <artifactId>dockerfile-maven-plugin</artifactId>
                <version>1.4.10</version>
                <configuration>
                    <!--<serverId>docker-hub</serverId>-->
                    <useMavenSettingsForAuth>true</useMavenSettingsForAuth>
                    <!--<registryUrl>https://index.docker.io/v1/</registryUrl>-->
                    <repository>dakarinternational/dakar</repository>
                    <buildArgs>
                        <JAR_FILE>target/${project.build.finalName}.jar</JAR_FILE>
                    </buildArgs>
                </configuration>
            </plugin>

Notice the <JAR_FILE> build argument.

CircleCI

If you don't want to use Docker-compose environment variables, then you can also pass directly circleci secret environment variable like this:

- run:  
    name: java command   
    command: |  
      java -Ddb-password=$DB_PWD -jar blabla.jar

Notice the $DB_PWD circleci secret environment variable

Vault by HashiCorp

Another solution to avoid all these variables transmissions is to use Vault.

]]>