Introducing deprecated code check in CI

[MohitMaliFtechiz]

Fixes #3409

Since our project is a multi-module and previously we are using the wrong command of detekt, now we are using the updated command of detekt ./gradlew detektDebug detektCustomExampleDebug to check all issues in both modules.

• We have introduced that if any deprecated code is found in the project then detekt will fail.
• It also fails when we are committing in our local machine since we have updated the pre-commit.sh file.
• We already have a Compat21 file to handle the deprecated code, which does not have any alternative. we will manage that code in this file.
• We have suppressed the KiwixService file as we are using SimpleXmlConverterFactory and we do not have any alternative for this.
• We have improved some deprecated rules of detekt.

[codecov]

Codecov Report

Patch coverage has no change and project coverage change: -0.01 ⚠️

Comparison is base (c49d8d8) 48.68% compared to head (3f6c997) 48.67%.

Additional details and impacted files

@@              Coverage Diff              @@
##             develop    #3440      +/-   ##
=============================================
- Coverage      48.68%   48.67%   -0.01%     
- Complexity      1011     1012       +1     
=============================================
  Files            285      285              
  Lines          10096    10095       -1     
  Branches        1348     1348              
=============================================
- Hits            4915     4914       -1     
  Misses          4399     4399              
  Partials         782      782              

Impacted Files	Coverage Δ
...ava/org/kiwix/kiwixmobile/core/compat/CompatV21.kt	60.00% <ø> (-6.67%)	⬇️
...kiwix/kiwixmobile/core/data/remote/KiwixService.kt	100.00% <ø> (ø)

... and 4 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[kelson42]

@MohitMaliFtechiz I really wonder why the CI is green considering this branch is based on a version of gitv ain witj deprecated code!?

[MohitMaliFtechiz]

@kelson42, We have configured the CI failure if deprecated code is found in the assemble CI and that is failing right now since we have some deprecated code in our project. /~https://github.com/kiwix/kiwix-android/actions/runs/5411219667/jobs/9833687025?pr=3440

[kelson42]

@MohitMaliFtechiz I want the code to fail for any deprecation scenario you have fixed in the last 3 weeks. I don't want to see deprecation warning at compilation time.

[gouri-panda]

@MohitMaliFtechiz After the discussion. We should go with Detekt custom rules for detecting the deprecated code. The current approach isn't viable for this issue.

[MohitMaliFtechiz]

@gouri-panda, I agree with you.

• I used Detekt to address the usage of deprecated code in the project and updated the deprecated Detekt rules.
• After conducting thorough research, I discovered that we were using the wrong detekt command to check for any issues. Since our project is a multi-module project, the detekt command does not work here. Instead, we need to use it separately for both the custom and app modules. More details can be found at this link: Detekt Issue #2038.
• After updating the rules and implementing the aforementioned approach, Detekt identified additional issues that need to be fixed, such as "not using a double band operator" and "UnnecessaryAbstractClass".
• However, this approach also includes the imports in the deprecation warning, which causes the build to fail. You can refer to the screenshot below for more information.

[gouri-panda]

@MohitMaliFtechiz We should fix the detekt problem before we merge that. Otherwise, code looks good.

[kelson42]

I guess we need to merge #3447 first?!

[gouri-panda]

@kelson42 Yes, hopefully #3447 will solve the problem.