rust_hacks.md

   1 # Scope of this document
   2
   3 This document aims to document some nice "hacks" and tricks to employ when packaging crates.
   4
   5 ## Getting an overview of missing crates
   6
   7 A nice tool to generate a graphical overview of a rust projects' dependency tree is `cargo debstatus`. Install it like that:
   8 `cargo install cargo-debstatus`. Then download either a release or clone the git project and `cd` into there. Run `cargo debstatus` to get a nice graph about dependencies and reverse dependencies.
   9
  10 ## Patching crates
  11 If a crate needs a) a newer dependency or b) an older dependency than the one in the archive you need to patch the crate. This is relatively common. You can also use this to patch out features in Cargo.toml or make changes to the source code.
  12
  13 Since the source is pulled from crates.io and not from github/lab, patching requires downloading the source from there. There are two ways to achieve this:
  14
  15 1) Install `cargo-download`: `cargo install cargo-download`
  16 1.1) Download the source: `cargo download foocrate version > foocrate.tar.gz`
  17 1.2) Extract the crate: `tar -xf foocrate.tar.gz`
  18 1.3) `cd foocrate-version && git init && git add . && git commit -m "d"`
  19 1.4) Edit e.g. Cargo.toml to relax the dependencies: Instead of version 0.4 of a crate bump it to 0.5 ( if that is the corresponding debian version) or down to 0.3 (if that is the debian version)
  20 1.5) Generate a patch with your changes: `git diff -p >> relax-deps.diff`
  21 1.6) `cp relax-deps.diff debcargo-conf/src/foocrate/debian`
  22 1.7) `cd debcargo-conf/src/foocrate/debian && mkdir patches`
  23 1.8) `mv relax-deps.diff patches/ && cd patches && echo relax-deps.diff >> series`
  24 1.9) `cd ../../../../`
  25 1.10) run `./update.sh foocrate` again. The patch should get applied and allow you to build against an older/newer dependency / with features disabled.
  26 1.11) Document your patches in d/changelog
  27 2) `wget http://crates.io/api/v1/crates/foocrate/version/download -O foocrate-version.tar.gz`
  28 Then follow 1.1)
  29
  30 capitol did a nice writeup which can be read here:
  31 https://blog.hackeriet.no/packaging-rust-part-II/
  32
  33
  34
  35
  36 ## Skipping tests / special d/rules overrides
  37
  38 Sometimes you get broken tests that can't be excluded or patched away. For instance if a test would require direct access to the RAM which isn't possible with `sbuild`. Then it is reasonable to skip those in `d/rules`.
  39
  40 1) `cd src/foocrate/debian && touch rules`
  41 2) `cd ../../../ && ./update.sh foocrate`. This will generate a `rules.debcargo.hint` file you can use as template, similar to d/copyright
  42 3) `cd src/foocrate/debian && cp rules.debcargo.hint rules`
  43 4) use your favorite editor to edit the rules file to your needs. For skipping tests you can do the following:
  44
  45 ```
  46 override_dh_auto_test:
  47         dh_auto_test -- test -- --skip tests::broken_test --skip tests::second_broken_test
  48 ```
  49
  50 if those are the broken tests. Then `cd` in the top-level directory and run `./update.sh` again. You might also need to skip the same tests in the autopkgtest runner. To do that, create a `tests/control` file in the `debian/` folder.
  51
  52
  53 ## Packaging binary crates
  54
  55 TODO
  56
  57 ## debcargo.toml tweaks
  58
  59 ### Excluding files
  60 In case you need to exclude certain files from `debcargo.toml`, there is an easy way to do that.
  61 Just add `excludes = ["foo/bar.rs", ""bar/non-dfsg-file"]` in debcargo.toml. This has the following usecases:
  62
  63 - Exclude non-dfsg/unnecessary files form the orig tarball (Example: svg-metadata)
  64   This is also **required** for some sys-crates to exclude vendored copies of the C library already in debian
  65 - Exclude broken tests that do not run (when in doubt, ask on #debian-rust) (Example: cxx )
  66
  67 ### Passing external packages to the buildsystem
  68
  69 If the crate needs external packages (such as -dev libraries) you can also pass those conveniently via `debcargo.toml` :
  70 ` depends = ["libfoo-dev"]  `. This is essentially needed for all -sys crates which provide rust bindings to C developement libraries such as GTK, for instance.
  71
  72 ### Passing runtime test dependencies to autopkgtest
  73
  74 In rare cases the autopkgtest can fail on the official runners compared to the local one because it has a slightly different setup.
  75 You can do this like that: `test_depends = ["foo"]`. That happens very rarely, see `cxx` for an example.
  76
  77 ### Whitelisting files
  78
  79 Sometimes debcargo marks files as suspicious, most of the time those are tests written in C for -sys crates. Whitelist them like that:
  80 `whitelist = [tests/foo.c"]` . (Example: lidadwaita-sys)
  81
  82 ### Allowing alpha/beta dependencies
  83
  84 Some crates depend on a crate with an alpha/beta version strings. debcargo will emit an error if that is the case. To allow those deps, pass the following:
  85 `allow_prerelease_deps = true`. Do this only if you are sure this will work !
  86
  87
  88 ### Collapsing features
  89 If a crate has features, `collapse_features = true` **should** be set in `debcargo.toml`. This is strongly recommended. See issue #17 in the debcargo repo for the reasoning.
  90
  91
  92 ### Marking feature tests as broken
  93
  94 Let's assume  you are building a package and get the following output at the end:
  95
  96 ```
  97
  98 autopkgtest [22:45:42]: test librust-foo-dev:: -----------------------]
  99 autopkgtest [22:45:42]: test librust-foo-dev::  - - - - - - - - - - results - - - - - - - - - -
 100 librust-foo-dev: PASS
 101 autopkgtest [22:45:42]: @@@@@@@@@@@@@@@@@@@@ summary
 102 rust-foo:@ FAIL non-zero exit status 101
 103 librust-foo-dev:default PASS
 104 librust-foo-dev: PASS
 105 librust-foo-dev:serde: FAIL non-zero exit status 101
 106
 107 ```
 108 As we can see, the `serde` and `@` feature fail. Since the other features (and the package itself) passes, we need to mark those test as flaky so the package can migrate to testing.
 109 Do it like that:
 110 ```
 111 #serde and @ feature fail the autopkgtest
 112 [packages.lib]
 113 test_is_broken = false
 114 [packages."lib+@"]
 115 test_is_broken = true
 116 [packages."lib+serde"]
 117 test_is_broken = true
 118 ```
 119 Examples: cxx, hashbrown, uom, ...
 120
 121 Do this only if *some* features fail. If all feature tests fail, read the test logs and look at the upstream test system. Make sure that some tests pass or that the tests aren't meant to be run. Some upstream projects run all test in a specific container or use specific setup. Also some crates are only tested with their default features enabled by upstream. If that's the case mark all test as broken:
 122
 123 ```
 124 # tests need a postgres container to run
 125 [packages.lib]
 126 test_is_broken = true
 127
 128 ```
 129 Examples: tokio-postgres, ...
 130
 131 Sometime you need to combine some tricks to run at least some tests: Exclude a faulty test, patch dependencies away and mark tests as broken.
 132
 133 ### More resources
 134 For a full documentation of all keywords available in `debcargo.toml` refer to debcargo.toml.example in the debcargo repo.
 135
 136
 137 ## Arch-specific failures
 138
 139 It can rarely happen that tests (read: autopkgtest) fail on specific arches because how bytes are addressed on that arch. The best course of action is to investigate first if it indeed is an arch-specific failure.
 140 If that's the case you need to write a patch that skips those faulty tests (on that arch) so the package can enter testing. Because arch names are different in rust, here is a handy table comparing them:
 141
 142
 143 | Debian arch name | rust arch name (target_arch) |
 144 |----------------------|---------------------------|
 145 | Arches autopkgtest runs on (needed for testing migration) | |
 146 | amd64            | x86-64         |
 147 | i386             | x86 |
 148 | arm64            | aarch64        |
 149 | armel            | arm        |
 150 | armhf            | arm |
 151 | ppc64el | powerpc64 |
 152 | s390x | powerpc64? |
 153 | **Other official arches¹** | |
 154 | mipsel | mips? |
 155 | mips64el | mips64 |
 156 | **Unoffical ports with rustc/cargo (not really relevant)** | |
 157 |  powerpc      | powerpc? |
 158 | ppc64         | powerpc? |
 159 | riscv64 | riscv64 |
 160 | sparc64 | sparc64? |
 161 | x32 | ? |
 162
 163 Arches without rustc/cargo:
 164 - sh4²
 165 - alpha
 166 - arc
 167 - hppa
 168 - hurd-i386
 169 - ia64
 170 - kfreebsd-amd64
 171 - kfreebsd-i386
 172 - m68k
 173
 174 Only the first seven are really relevant, I included the rest for completeness's sake.
 175 If you encounter a test failure e.g. on `armel`, add this macro before the `#[test]` macro:
 176  ` #[cfg(not(target_arch = "arm"))] `.
 177  Then generate a patch with the changes and include it in the usual way. Also notify upstream that this arch is broken and send them your patch.
 178 Footnotes:  [1] https://wiki.debian.org/SupportedArchitectures
 179             [2] sh4 has only one test failure for cargo
 180
 181