Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add package signing script to the CI pipeline #4399

Merged
merged 4 commits into from
Nov 28, 2024
Merged

Conversation

jacekwegr
Copy link
Collaborator

@jacekwegr jacekwegr commented Nov 15, 2024

Summary

This PR adds package signing to the CI pipeline within the Docker containers used for building. It also updates the previously used signing tool for .deb packages.


Key Changes

  1. Package Signing

    • Adds a script to sign packages immediately after they are built in Docker, but before running smoke tests, to confirm that the packages remain functional after signing.
    • The script adapts to the package type, using appropriate signing tools.
  2. Switch to debsigs for .deb Package Signing

    • Replaces dpkg-sig with debsigs as the signing tool for .deb packages.
    • Why the change?
      • dpkg-sig does not support the zstd compression standard, is unavailable on Debian >= 12 and Ubuntu >= 23.10 and appears to be no longer maintained.
      • debsigs supports zstd, is actively maintained and is compatible with newer Ubuntu/Debian versions.
    • Compatibility Workaround:
      • debsigs requires a workaround for older Ubuntu/Debian versions (we need version >0.2 to use --gpgopts option). A similar workaround would also be required for dpkg-sig to work with newer versions, making debsigs the better long-term choice.
  3. Environment Variables

    • Adds the following environment variables in CircleCI to handle GPG keys:
      • GPG_PUBLIC_KEY
      • GPG_PRIVATE_KEY
      • GPG_PASS
    • Both public and private keys are base64-encoded, allowing them to be stored and passed as single-line values. This avoids issues with multi-line keys.
    • These variables are passed to Docker via secret mounts. To enable this feature, the line # syntax=docker/dockerfile:1 was added to the Dockerfile to use the latest Dockerfile syntax.

@mongoose-im

This comment was marked as outdated.

Copy link

codecov bot commented Nov 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.28%. Comparing base (d4bc662) to head (290aaec).
Report is 18 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4399      +/-   ##
==========================================
+ Coverage   85.05%   85.28%   +0.22%     
==========================================
  Files         550      550              
  Lines       33861    33861              
==========================================
+ Hits        28802    28878      +76     
+ Misses       5059     4983      -76     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@jacekwegr jacekwegr force-pushed the sign-mim-packages branch 4 times, most recently from 47fccd1 to cf287d7 Compare November 20, 2024 09:26
@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@jacekwegr jacekwegr marked this pull request as ready for review November 20, 2024 14:01
@jacekwegr jacekwegr changed the title Add script to sign packages [WiP] Add script to sign packages Nov 21, 2024
@jacekwegr jacekwegr marked this pull request as draft November 21, 2024 09:40
@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@jacekwegr jacekwegr changed the title [WiP] Add script to sign packages Add package signing script to the CI pipeline Nov 22, 2024
@jacekwegr jacekwegr marked this pull request as ready for review November 22, 2024 09:27
@jacekwegr jacekwegr marked this pull request as draft November 27, 2024 08:10
@mongoose-im

This comment was marked as outdated.

@mongoose-im

This comment was marked as outdated.

@mongoose-im
Copy link
Collaborator

mongoose-im commented Nov 28, 2024

elasticsearch_and_cassandra_27 / elasticsearch_and_cassandra_mnesia / 290aaec
Reports root/ big
OK: 473 / Failed: 0 / User-skipped: 49 / Auto-skipped: 0


small_tests_27 / small_tests / 290aaec
Reports root / small


small_tests_26 / small_tests / 290aaec
Reports root / small


small_tests_27_arm64 / small_tests / 290aaec
Reports root / small


ldap_mnesia_26 / ldap_mnesia / 290aaec
Reports root/ big
OK: 2350 / Failed: 0 / User-skipped: 910 / Auto-skipped: 0


ldap_mnesia_27 / ldap_mnesia / 290aaec
Reports root/ big
OK: 2350 / Failed: 0 / User-skipped: 910 / Auto-skipped: 0


internal_mnesia_27 / internal_mnesia / 290aaec
Reports root/ big
OK: 2491 / Failed: 1 / User-skipped: 768 / Auto-skipped: 0

pubsub_SUITE:dag+basic:publish_test
{error,{{badmatch,false},
    [{pubsub_tools,check_response,2,
             [{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
            {line,444}]},
     {pubsub_tools,receive_response,3,
             [{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
            {line,434}]},
     {pubsub_tools,receive_and_check_response,4,
             [{file,"/home/circleci/project/big_tests/tests/pubsub_tools.erl"},
            {line,424}]},
     {pubsub_SUITE,'-publish_test/1-fun-0-',1,
             [{file,"/home/circleci/project/big_tests/tests/pubsub_SUITE.erl"},
            {line,453}]},
     {escalus_story,story,4,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
             {line,72}]},
     {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
     {test_server,run_test_case_eval1,6,
            [{file,"test_server.erl"},{line,1303}]},
     {test_server,run_test_case_eval,9,
            [{file,"test_server.erl"},{line,1235}]}]}}

Report log


dynamic_domains_pgsql_mnesia_27 / pgsql_mnesia / 290aaec
Reports root/ big
OK: 4755 / Failed: 0 / User-skipped: 119 / Auto-skipped: 0


pgsql_cets_27 / pgsql_cets / 290aaec
Reports root/ big
OK: 4632 / Failed: 0 / User-skipped: 186 / Auto-skipped: 0


dynamic_domains_mysql_redis_27 / mysql_redis / 290aaec
Reports root/ big
OK: 4722 / Failed: 0 / User-skipped: 152 / Auto-skipped: 0


dynamic_domains_pgsql_mnesia_26 / pgsql_mnesia / 290aaec
Reports root/ big
OK: 4755 / Failed: 0 / User-skipped: 119 / Auto-skipped: 0


dynamic_domains_mssql_mnesia_27 / odbc_mssql_mnesia / 290aaec
Reports root/ big
OK: 4752 / Failed: 0 / User-skipped: 122 / Auto-skipped: 0


mysql_redis_27 / mysql_redis / 290aaec
Reports root/ big
OK: 5127 / Failed: 0 / User-skipped: 147 / Auto-skipped: 0


pgsql_mnesia_26 / pgsql_mnesia / 290aaec
Reports root/ big
OK: 5146 / Failed: 0 / User-skipped: 128 / Auto-skipped: 0


pgsql_mnesia_27 / pgsql_mnesia / 290aaec
Reports root/ big
OK: 5140 / Failed: 1 / User-skipped: 128 / Auto-skipped: 5

bosh_SUITE:essential_https:accept_higher_hold_value
{error,
  {{assertEqual,
     [{module,bosh_SUITE},
      {line,261},
      {expression,"get_bosh_sessions ( )"},
      {expected,[]},
      {value,
        [{bosh_session,<<"3d58bcfc8ec92ce9f46f1dffe52e7a336be4db4d">>,
           <10428.10587.0>}]}]},
   [{bosh_SUITE,accept_higher_hold_value,1,
      [{file,"/home/circleci/project/big_tests/tests/bosh_SUITE.erl"},
       {line,261}]},
    {test_server,ts_tc,3,[{file,"test_server.erl"},{line,1794}]},
    {test_server,run_test_case_eval1,6,
      [{file,"test_server.erl"},{line,1303}]},
    {test_server,run_test_case_eval,9,
      [{file,"test_server.erl"},{line,1235}]}]}}

Report log


cockroachdb_cets_27 / cockroachdb_cets / 290aaec
Reports root/ big
OK: 4632 / Failed: 0 / User-skipped: 186 / Auto-skipped: 0


mssql_mnesia_27 / odbc_mssql_mnesia / 290aaec
Reports root/ big
OK: 5140 / Failed: 3 / User-skipped: 131 / Auto-skipped: 0

disco_and_caps_SUITE:disco_with_caps:user_can_query_friend_features
{error,{{assertion_failed,assert_many,false,[is_roster_set],[],[]},
    [{escalus_new_assert,assert_true,2,
               [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_new_assert.erl"},
                {line,84}]},
     {escalus_story,'-make_all_clients_friends/1-fun-0-',2,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
             {line,108}]},
     {escalus_utils,'-each_with_index/3-fun-0-',3,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_utils.erl"},
             {line,87}]},
     {lists,foldl_1,3,[{file,"lists.erl"},{line,2151}]},
     {escalus_utils,'-each_with_index/3-fun-0-',3,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_utils.erl"},
             {line,87}]},
     {lists,foldl,3,[{file,"lists.erl"},{line,2146}]},
     {escalus_utils,distinct_pairs,2,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_utils.erl"},
             {line,60}]},
     {escalus_story,make_all_clients_friends,1,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
             {line,106}]}]}}

Report log

disco_and_caps_SUITE:disco_with_caps:user_can_query_friend_resources
{error,{{assertion_failed,assert_many,false,[is_roster_set],[],[]},
    [{escalus_new_assert,assert_true,2,
               [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_new_assert.erl"},
                {line,84}]},
     {escalus_story,'-make_all_clients_friends/1-fun-0-',2,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
             {line,108}]},
     {escalus_utils,'-each_with_index/3-fun-0-',3,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_utils.erl"},
             {line,87}]},
     {lists,foldl_1,3,[{file,"lists.erl"},{line,2151}]},
     {escalus_utils,'-each_with_index/3-fun-0-',3,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_utils.erl"},
             {line,87}]},
     {lists,foldl,3,[{file,"lists.erl"},{line,2146}]},
     {escalus_utils,distinct_pairs,2,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_utils.erl"},
             {line,60}]},
     {escalus_story,make_all_clients_friends,1,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
             {line,106}]}]}}

Report log

disco_and_caps_SUITE:disco_with_caps:user_cannot_query_friend_resources_with_unknown_node
{error,{{assertion_failed,assert_many,false,[is_roster_set,is_presence],[],[]},
    [{escalus_new_assert,assert_true,2,
               [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_new_assert.erl"},
                {line,84}]},
     {escalus_story,'-make_all_clients_friends/1-fun-0-',2,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
             {line,111}]},
     {escalus_utils,'-each_with_index/3-fun-0-',3,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_utils.erl"},
             {line,87}]},
     {lists,foldl_1,3,[{file,"lists.erl"},{line,2151}]},
     {escalus_utils,'-each_with_index/3-fun-0-',3,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_utils.erl"},
             {line,87}]},
     {lists,foldl,3,[{file,"lists.erl"},{line,2146}]},
     {escalus_utils,distinct_pairs,2,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_utils.erl"},
             {line,60}]},
     {escalus_story,make_all_clients_friends,1,
            [{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
             {line,106}]}]}}

Report log


internal_mnesia_27 / internal_mnesia / 290aaec
Reports root/ big
OK: 2492 / Failed: 0 / User-skipped: 768 / Auto-skipped: 0


pgsql_mnesia_27 / pgsql_mnesia / 290aaec
Reports root/ big
OK: 5146 / Failed: 0 / User-skipped: 128 / Auto-skipped: 0


mssql_mnesia_27 / odbc_mssql_mnesia / 290aaec
Reports root/ big
OK: 5143 / Failed: 0 / User-skipped: 131 / Auto-skipped: 0


pgsql_cets_27 / pgsql_cets / 290aaec
Reports root/ big
OK: 4632 / Failed: 0 / User-skipped: 186 / Auto-skipped: 0

@jacekwegr jacekwegr marked this pull request as ready for review November 28, 2024 12:29
Copy link
Member

@chrzaszcz chrzaszcz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I like the usage of secrets 👍

@chrzaszcz chrzaszcz merged commit 96818b2 into master Nov 28, 2024
4 checks passed
@chrzaszcz chrzaszcz deleted the sign-mim-packages branch November 28, 2024 16:01
@jacekwegr jacekwegr added this to the 6.3.1 milestone Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants