Package dmarc-srg into Debian #154

williamdes · 2025-01-24T21:46:02Z

This is so much of a great tool and I can not donate, that I can only propose to make it enter Debian.

What does it require:

Not too much dependencies to package (

Lines 14 to 22 in 4c932e7

    
              "require": { 
        
                  "php": ">=7.3", 
        
                  "ext-json": "*", 
        
                  "ext-mbstring": "*", 
        
                  "ext-pdo_mysql": "*", 
        
                  "ext-xml": "*", 
        
                  "ext-zip": "*", 
        
           "phpmailer/phpmailer": "^6.8.0", 
        
                  "league/flysystem-aws-s3-v3": "^2.5"

)

No licensing issues: all the code is owned by @liuch and there is nearly no external ressource. And the project licence is good for Debian: https://github.com/liuch/dmarc-srg/blob/master/LICENSE - https://wiki.debian.org/DFSGLicenses

@liuch do you have any observations ?

I found no ITP in https://wnpp.debian.net/ ~~so I will file a new one~~: Done, here it is https://bugs.debian.org/1094136

The packaging will take place in https://salsa.debian.org/php-team/pear/dmarc-srg

liuch · 2025-01-24T22:11:16Z

Thank you for your attention to my project! I appreciate that.
As for my observations: the last two dependencies are only needed if S3 storage is used. Are any additional actions required of me?

BTW: Some time ago I was surprised to discover that DmarcSrg is used in NetBSD.

williamdes · 2025-01-24T22:25:55Z

Thank you for your attention to my project! I appreciate that.

It is really cool, and Debian has no such tool.
The tech is perfectly clean, I love using dmarc-srg as you can feel in the interfaces that there is no JS dependencies or large vendors to load.

As for my observations: the last two dependencies are only needed if S3 storage is used. Are any additional actions required of me?

Okay, perfect. That is what I had in mind.
I will set them as suggested dependencies.

I did notice your copyright on the files is 2020 but the first commit it 2021. Is 2020 the right year for the start of your copyright ?

BTW: Some time ago I was surprised to discover that DmarcSrg is used in NetBSD.

Oh cool !
https://repology.org/project/php%3Admarc-srg/versions

williamdes · 2025-01-24T22:27:06Z

You seem to have phpunit tests, is there a reason to not use GitHub actions to run them ?

williamdes · 2025-01-24T22:34:32Z

Do you use Debian or Ubuntu ?
I mean, to test dmarc-srg once I finish the packaging.

liuch · 2025-01-24T22:42:49Z

I did notice your copyright on the files is 2020 but the first commit it 2021. Is 2020 the right year for the start of your copyright ?

Project started in 2020 and only used on my personal server. In January 2021, I put it online.

You seem to have phpunit tests, is there a reason to not use GitHub actions to run them ?

For now, I see no reason to use Github actions as long as the same tests I can run on my local computer. Maybe later.

Do you use Debian or Ubuntu ?
I mean, to test dmarc-srg once I finish the packaging.

I use Debian (trixie).

williamdes · 2025-01-24T22:47:48Z

For now, I see no reason to use Github actions as long as the same tests I can run on my local computer. Maybe later.

Okay, for information I will run your tests in debian. They call it autopkgtests.
And will probably add some selenium tests to ensure the package works

I use Debian (trixie).

Awesome, you will have the package first then!

williamdes · 2025-01-24T22:53:12Z

I will have to patch the software to move the path of config/conf.php to /etc/dmarc-srg/conf.php
Can we have in future versions a constant for all the project ?
init.php seems to be ready for this.

At phpMyAdmin we have a vendor_config file to help maintaining such patches: https://github.com/phpmyadmin/phpmyadmin/blob/master/app/vendor_config.php

Edit: I am not sure why but only the Apache2 logs indicate that the file is missing. Maybe some lines to print a message could work ?

williamdes · 2025-01-24T23:47:28Z

I tried running the tests, and phpunit 11 (version in Debian) is unhappy about all the mocks..

But this 3 ones are easy to fix with zero impacts:

1) Liuch\DmarcSrg\UserTest::testLevelToStringCorrectValue
The data provider specified for Liuch\DmarcSrg\UserTest::testLevelToStringCorrectValue is invalid
Data Provider method Liuch\DmarcSrg\UserTest::dataProvider1() is not static

/mnt/Dev/@debian/@wdes-packaging-team/dmarc-srg/tests/classes/Users/UserTest.php:26

2) Liuch\DmarcSrg\UserTest::testLevelToStringIncorrectValue
The data provider specified for Liuch\DmarcSrg\UserTest::testLevelToStringIncorrectValue is invalid
Data Provider method Liuch\DmarcSrg\UserTest::dataProvider1() is not static

/mnt/Dev/@debian/@wdes-packaging-team/dmarc-srg/tests/classes/Users/UserTest.php:34

3) Liuch\DmarcSrg\UserTest::testStringToLevelCorrectValue
The data provider specified for Liuch\DmarcSrg\UserTest::testStringToLevelCorrectValue is invalid
Data Provider method Liuch\DmarcSrg\UserTest::dataProvider1() is not static

/mnt/Dev/@debian/@wdes-packaging-team/dmarc-srg/tests/classes/Users/UserTest.php:46

liuch · 2025-01-25T20:30:36Z

I will have to patch the software to move the path of config/conf.php to /etc/dmarc-srg/conf.php
Can we have in future versions a constant for all the project ?

Done.

liuch · 2025-01-25T20:45:45Z

Edit: I am not sure why but only the Apache2 logs indicate that the file is missing. Maybe some lines to print a message could work ?

Do you mean that information about unavailability of the configuration file should be output not only to the log, but also to the browser / console?

I tried running the tests, and phpunit 11 (version in Debian) is unhappy about all the mocks..

Unfortunately, phpunit is currently broken in my debian instance, I can't check and fix the tests right now. I'm waiting for update for phpunit from Debian team.

williamdes · 2025-01-27T00:57:29Z

I will have to patch the software to move the path of config/conf.php to /etc/dmarc-srg/conf.php
Can we have in future versions a constant for all the project ?

Done.

Thank you, it looks good !

Ref: b459815 also to fix it

williamdes · 2025-01-27T00:58:56Z

Do you mean that information about unavailability of the configuration file should be output not only to the log, but also to the browser / console?

Yes indeed, the browser was missing that indication.

Unfortunately, phpunit is currently broken in my debian instance, I can't check and fix the tests right now. I'm waiting for update for phpunit from Debian team.

What do you mean, do you use the version in testing or unstable ?
What is the current error ?

liuch · 2025-01-27T01:08:44Z

Yes indeed, the browser was missing that indication.

That makes sense. But only if the current user is admin. For other users, display something else, I think.

liuch · 2025-01-27T01:15:00Z

What do you mean, do you use the version in testing or unstable ?
What is the current error ?

Trixie, the latest version.

$ phpunit --version
PHPUnit 11.5.3 by Sebastian Bergmann and contributors.

$ tests/run.sh 
PHPUnit 11.5.3 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.2.27

EEEEEEEE....................E.......E.D..EEEEE...EEFFFEFEEEEEEE  63 / 188 ( 33%)
EEE..........EEEF.EEEEEEEEEEEEEFEEEFFEEEEFEEEFFFEEEE........... 126 / 188 ( 67%)
....................EEEEEEEEEEFFEEFFFEEEEEEEEEEEEE............  188 / 188 (100%)

An error occurred inside PHPUnit.

Message:  file_put_contents(/usr/bin/.phpunit.result.cache): Failed to open stream: Permission denied
Location: /usr/share/php/PHPUnit/Runner/ResultCache/DefaultResultCache.php:160

#0 [internal function]: PHPUnit\TextUI\Application->{closure}()
#1 /usr/share/php/PHPUnit/Runner/ResultCache/DefaultResultCache.php(160): file_put_contents()
#2 /usr/share/php/PHPUnit/Runner/ResultCache/ResultCacheHandler.php(60): PHPUnit\Runner\ResultCache\DefaultResultCache->persist()
#3 /usr/share/php/PHPUnit/Runner/ResultCache/Subscriber/TestSuiteFinishedSubscriber.php(24): PHPUnit\Runner\ResultCache\ResultCacheHandler->testSuiteFinished()
#4 /usr/share/php/PHPUnit/Event/Dispatcher/DirectDispatcher.php(106): PHPUnit\Runner\ResultCache\TestSuiteFinishedSubscriber->notify()
#5 /usr/share/php/PHPUnit/Event/Dispatcher/DeferringDispatcher.php(47): PHPUnit\Event\DirectDispatcher->dispatch()
#6 /usr/share/php/PHPUnit/Event/Emitter/DispatchingEmitter.php(1194): PHPUnit\Event\DeferringDispatcher->dispatch()
#7 /usr/share/php/PHPUnit/Framework/TestSuite.php(374): PHPUnit\Event\DispatchingEmitter->testSuiteFinished()
#8 /usr/share/php/PHPUnit/TextUI/TestRunner.php(64): PHPUnit\Framework\TestSuite->run()
#9 /usr/share/php/PHPUnit/TextUI/Application.php(210): PHPUnit\TextUI\TestRunner->run()
#10 /usr/bin/phpunit(104): PHPUnit\TextUI\Application->run()

This may be because I haven't updated php to the latest version yet.

williamdes · 2025-01-27T01:21:54Z

This may be because I haven't updated php to the latest version yet.

Nevermind this, there is two ways

add a path to cache in phpunit.xml.dist
use --do-not-cache-results

It will not go away by itself, this is new in phpunit
and occurs aspecially when you do not have a phpunit config file

liuch · 2025-01-27T01:34:40Z

Thank you for information. --do-not-cache-result worked out. Many other errors appeared. Looks like a lot of changes have been made in the new version of phpunit. I'll need to read the documentation.

liuch · 2025-01-27T15:12:00Z

Done.

$ tests/run.sh 
PHPUnit 11.5.3 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.2.27

...............................................................  63 / 188 ( 33%)
............................................................... 126 / 188 ( 67%)
..............................................................  188 / 188 (100%)

Time: 00:01.116, Memory: 12.00 MB

OK (188 tests, 639 assertions)

williamdes · 2025-01-28T21:29:13Z

I am amazed, this got to Debian FTP masters that did review it directly.
And it got accepted ! 🎉
Congratulations, you are in Debian ! Soon it will auto sync into Ubuntu and other derivatives.

Tracking (will look better tomorrow): https://tracker.debian.org/pkg/dmarc-srg

liuch · 2025-01-29T15:00:09Z

That's great news. When I decided to put my project on the web, I assumed that few people would use it because of its simplicity and specificity of use. Of course, I didn't even think it would be considered worthy of use in Debian. I'm impressed! Thank you so much!

williamdes · 2025-01-29T16:23:40Z

That's great news. When I decided to put my project on the web, I assumed that few people would use it because of its simplicity and specificity of use. Of course, I didn't even think it would be considered worthy of use in Debian. I'm impressed! Thank you so much!

It's simplicity is one of the first key points of your work. It just works💯
users love it 😍
No promises but maybe i can get it to Debian bookworm-backports.

Please check the security tab of github and write a policy to help future researchers 😉

I will write a blog post about your incredible tool some time soon

liuch added a commit that referenced this issue Jan 25, 2025

add vendor configuration file (#154)

c876bc2

liuch added a commit that referenced this issue Jan 25, 2025

fix tests (#154)

24a9425

liuch added a commit that referenced this issue Jan 27, 2025

fix the tests for PHPUnit 11 (#154)

b098f56

williamdes closed this as completed Jan 28, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Package dmarc-srg into Debian #154

Package dmarc-srg into Debian #154

williamdes commented Jan 24, 2025 •

edited

Loading

liuch commented Jan 24, 2025

williamdes commented Jan 24, 2025

williamdes commented Jan 24, 2025

williamdes commented Jan 24, 2025

liuch commented Jan 24, 2025

williamdes commented Jan 24, 2025

williamdes commented Jan 24, 2025 •

edited

Loading

williamdes commented Jan 24, 2025

liuch commented Jan 25, 2025

liuch commented Jan 25, 2025 •

edited

Loading

williamdes commented Jan 27, 2025

williamdes commented Jan 27, 2025

liuch commented Jan 27, 2025

liuch commented Jan 27, 2025

williamdes commented Jan 27, 2025

liuch commented Jan 27, 2025

liuch commented Jan 27, 2025

williamdes commented Jan 28, 2025

liuch commented Jan 29, 2025

williamdes commented Jan 29, 2025

Package dmarc-srg into Debian #154

Package dmarc-srg into Debian #154

Comments

williamdes commented Jan 24, 2025 • edited Loading

liuch commented Jan 24, 2025

williamdes commented Jan 24, 2025

williamdes commented Jan 24, 2025

williamdes commented Jan 24, 2025

liuch commented Jan 24, 2025

williamdes commented Jan 24, 2025

williamdes commented Jan 24, 2025 • edited Loading

williamdes commented Jan 24, 2025

liuch commented Jan 25, 2025

liuch commented Jan 25, 2025 • edited Loading

williamdes commented Jan 27, 2025

williamdes commented Jan 27, 2025

liuch commented Jan 27, 2025

liuch commented Jan 27, 2025

williamdes commented Jan 27, 2025

liuch commented Jan 27, 2025

liuch commented Jan 27, 2025

williamdes commented Jan 28, 2025

liuch commented Jan 29, 2025

williamdes commented Jan 29, 2025

williamdes commented Jan 24, 2025 •

edited

Loading

williamdes commented Jan 24, 2025 •

edited

Loading

liuch commented Jan 25, 2025 •

edited

Loading