iOS plugin

[dedece35]

Description

This PR added support to iOS mobile apps (with Swift language support).

In order to work, the plugin needs to be installed alongside a plugin supporting Swift as a language such as sonar-apple (open source) or the commercial version from SonarSource.

This initial version comes with a single rule, but lays the groundwork for implementing (many !) more.
A basic CONTRIBUTION.md explains how to add new rules.

initial PR (before migration): cnumr/ecoCode#146
(plop @zippy1978 )

[dedece35]

Hi @zippy1978,
please take into account my review comments in this PR.

I'm not expert in ios development but I've worked with java and maven since many years. If you want to discuss about my comments on Slack appointment, no problem. It will be a pleasure to talk to you.

Hi @julien-hertout-neomades, @jhertout,
could you give me your test files to check that this new ios plugin is ok ? could we make an appointment on Slack / Meet to discuss about it ?

[zippy1978]

Hi @dedece35,
And thanks for your feedbacks.
I will have a look a them and probably get in touch with you when needed.

If possible, I will be interested to join the Slack as well !

[dedece35]

hi @zippy1978
no problem to join slack : what's your email slack account to invite you ?

[zippy1978]

@dedece35 gi.grousset@gmail.com :)

[dedece35]

with migration of SonarQube from 9.3 to 9.8, some source code must change ...
please check PR #13 on current repo

[dedece35]

Hi @zippy1978,
all is almost good.
please see the few remaining comments .

[zippy1978]

@jhertout @dedece35 ,
I did fix the packaging issue @jhertout had.

And also addressed the requested changes.

For the license header in files: I used this maven plugin (I used it on previous projects) : https://mycila.carbou.me/license-maven-plugin
It can add and check source file headers automatically. Maybe something to add on other plugins as well ?

[dedece35]

not CNumR but Green Code Initiative (same review note in all files)

[zippy1978]

Hi,
Actually the header is generated automatically from pom data.
In parent pom.xml organization is still CNumR.
I will update it.
Also url is still https://collectif.greenit.fr, should I change it as well ?

[jhertout]

We have a dedicated PR for this. We will change it later.

[dedece35]

maybe discuss about it during weekly meeting

[jhertout]

Hi @zippy1978,

Thanks for the update. I had be able to install and test the plugin. I have some last (I hope :)) remarks:

• In the docker-compose in the ios-plugin folder, can you remove the line "- "extensions:/opt/sonarqube/extensions". It does not work with it. It was a patch we did for a deployment in our Snapp' gitlab at the begining of the project. It is not required anymore.
• There is no "tags" in your rule description file. Can you add "ecocode, environment, idleness" as tags for the rule?
• Can you be a little more complete in the rule detail description: add why the rule is a bad practice by explaining what the original call does and why it is energy consuming. You can add the code "compliant" and "not compliant" samples too (only bad if necessary).
• I create a swift project to test the plugin (its aim is to have all the issues in a swift project and to see if they are detected by the plugin): https://github.com/green-code-initiative/ecoCode-mobile-ios-swift-test-project. When I perform an analyse using the sonar-scanner (see project readme), the analyse succeeds and the plugin works but I have exceptions during the scanner work:

Do you have an idea of what the problem is?

I notice that the ios-plugin deployment does not work with the "global" docker-file but we will fix it later. It is not important if the project works only in the "ios-plugin environment" for the moment.

Thanks

[zippy1978]

@jhertout

Regarding the stacktrace: it is not related to the ecoCode plugin but to the Swift lang support plugin (that is required) and that we have been developing at inside|app here: https://github.com/insideapp-oss/sonar-apple.

So we did some investigation, and it is probably caused by a mix in line ending chars in the source files.
I think you did test on Windows, and your git client is probably configured to adapt line ending on checkout (and use CR+LF chars, instead of leaving LF - as used on macOS and Linux) as a result SonarQube cannot detect lines in source files.

On Windows this feature is called "autocrlf".

This problem is SonarQube related (not specific / not related to specific plugin) and can happen with any language (see https://stackoverflow.com/questions/43997878/sonarqube-c-sharp-analysis-fails-to-not-a-valid-line-offset-for-pointer)

Note that the issue does not appear on macOS and Linux (using your test project + running SonarQube in docker-compose).

Could you double check the line ending chars on your test project sources ?

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

80.8% Coverage
0.0% Duplication

[zippy1978]

Hi @jhertout,

I addressed all the points you mentioned above.

The rule now looks like:

[jhertout]

Hello @zippy1978 ,

it seems ok for me. I don't remember if I answer you relating the stacktrace I sent to you but you were right. The problem was that I work on Windows and my EOL was changed by git.
I will try to perform a last test this week. If all is ok, I will merge this PR and we will follow the work in other PRs if necessary.

Thanks