debian-rust-rdeps 0.1.1

Helper tool for analyzing dependency relations between crate packages in a Debian repository
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
use std::{
    collections::{BTreeMap, BTreeSet, HashMap, HashSet},
    fs::File,
    path::Path,
};

use anyhow::{Context, Error, format_err};
use deb822_fast::FromDeb822Paragraph;
use debian_control::{
    lossy::{
        self, Relation, Relations, SourceRelation,
        apt::{Package, Source},
    },
    relations::VersionConstraint,
};
use debversion::Version;
use regex::Regex;
use serde::Serialize;
use tracing::{debug, info, warn};

pub struct PackageIndex {
    #[expect(dead_code)]
    pub package_versions: HashMap<String, HashSet<Version>>,
    pub packages: HashMap<(String, Version), Package>,
}

impl PackageIndex {
    pub fn new(
        package_versions: HashMap<String, HashSet<Version>>,
        packages: HashMap<(String, Version), Package>,
    ) -> Self {
        Self {
            package_versions,
            packages,
        }
    }
}

pub struct SourceIndex {
    #[expect(dead_code)]
    pub source_versions: HashMap<String, HashSet<Version>>,
    pub sources: HashMap<(String, Version), Source>,
}

impl SourceIndex {
    pub fn new(
        source_versions: HashMap<String, HashSet<Version>>,
        sources: HashMap<(String, Version), Source>,
    ) -> Self {
        Self {
            source_versions,
            sources,
        }
    }
}

pub fn parse_packages_index<P>(packages_paths: &[P]) -> Result<PackageIndex, Error>
where
    P: AsRef<Path> + std::fmt::Debug,
{
    let mut package_versions = HashMap::new();
    let mut packages = HashMap::new();

    for path in packages_paths {
        let old_count = package_versions.len();
        let file = File::open(path)
            .with_context(|| format!("Failed to open Packages index at {path:?}"))?;
        let deb822 = deb822_fast::Deb822::from_reader(&file)
            .map_err(|err| format_err!("Failed to parse Packages index at {path:?} - {err:?}"))?;

        for package_paragraph in deb822.iter() {
            match lossy::apt::Package::from_paragraph(package_paragraph) {
                Ok(pkg) => {
                    debug!("Found package {name}", name = &pkg.name);
                    let versions_entry = package_versions.entry(pkg.name.clone());
                    let versions_set = versions_entry.or_insert(HashSet::new());
                    versions_set.insert(pkg.version.clone());
                    packages.insert((pkg.name.clone(), pkg.version.clone()), pkg);
                }
                Err(err) => warn!("Failed to parse paragraph in {path:?} - {err:?}"),
            }
        }
        info!(
            "Found {count} packages in {path:?}",
            count = package_versions.len() - old_count,
        );
    }
    Ok(PackageIndex::new(package_versions, packages))
}

pub fn parse_sources_index<P>(sources_paths: &[P]) -> Result<SourceIndex, Error>
where
    P: AsRef<Path> + std::fmt::Debug,
{
    let mut source_versions = HashMap::new();

    let mut sources = HashMap::new();
    for path in sources_paths {
        let old_count = source_versions.len();
        let file = File::open(path)
            .with_context(|| format!("Failed to open Sources index at {path:?}"))?;

        let deb822 = deb822_fast::Deb822::from_reader(&file)
            .map_err(|err| format_err!("Failed to parse Sources index at {path:?} - {err:?}"))?;

        for source_paragraph in deb822.iter() {
            match lossy::apt::Source::from_paragraph(source_paragraph) {
                Ok(pkg) => {
                    let name = pkg.package.clone();
                    debug!("Found source package {name}");

                    let versions_entry = source_versions.entry(name.clone());

                    let versions_set = versions_entry.or_insert(HashSet::new());

                    versions_set.insert(pkg.version.clone());

                    sources.insert((name.clone(), pkg.version.clone()), pkg);
                }

                Err(err) => debug!("Failed to parse paragraph in {path:?} - {err:?}"),
            }
        }

        info!(
            "Found {count} source packages in {path:?}",
            count = source_versions.len() - old_count
        );
    }

    Ok(SourceIndex::new(source_versions, sources))
}

#[derive(Debug, Hash, PartialEq, Eq, PartialOrd, Ord, Clone)]
pub(crate) enum PackageKind {
    Binary,
    Source,
}

#[derive(Debug, Clone)]
pub(crate) struct RealPackage {
    pub(crate) name: String,
    pub(crate) version: Version,
    pub(crate) source: Option<SourceRelation>,
    pub(crate) kind: PackageKind,
}

impl Ord for RealPackage {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        self.name
            .cmp(&other.name)
            .then(self.version.cmp(&other.version))
            .then(self.kind.cmp(&other.kind))
    }
}

impl PartialOrd for RealPackage {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl Eq for RealPackage {}

impl PartialEq for RealPackage {
    fn eq(&self, other: &Self) -> bool {
        self.cmp(other) == std::cmp::Ordering::Equal && self.source == other.source
    }
}

impl std::hash::Hash for RealPackage {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.name.hash(state);
        self.version.hash(state);
        self.source.hash(state);
        self.kind.hash(state);
    }
}

#[derive(Debug, Hash, PartialEq, Eq, Clone)]
pub(crate) struct VirtualPackage {
    pub(crate) name: String,
    pub(crate) version: Option<(VersionConstraint, Version)>,
    pub(crate) provider: RealPackage,
}

#[derive(Debug, Hash, PartialEq, Eq, Clone)]
pub(crate) struct UnknownPackage {
    pub(crate) name: String,
    pub(crate) version: Option<(VersionConstraint, Version)>,
}

#[derive(Debug, Hash, PartialEq, Eq, Ord, PartialOrd, Clone, Serialize)]
pub enum DepKind {
    Provides,
    BuildDepends,
    BuildDependsArch,
    BuildDependsIndep,
    BuildConflicts,
    BuildConflictsArch,
    BuildConflictsIndep,
    TestSuiteTriggers,
    Depends,
    PreDepends,
    Recommends,
    Suggests,
    Conflicts,
    Breaks,
    StaticBuiltUsing,
}

fn map_relation(regex: &Regex, relation: &Relation) -> Option<UnknownPackage> {
    if regex.is_match(&relation.name) {
        Some(UnknownPackage {
            name: relation.name.clone(),
            version: relation.version.clone(),
        })
    } else {
        None
    }
}

fn handle_relation(
    reverse_deps: &mut BTreeMap<DepKind, BTreeMap<RealPackage, Vec<UnknownPackage>>>,
    found: UnknownPackage,
    real_package: &RealPackage,
    kind: DepKind,
) {
    debug!(
        "package {package_name} {kind:?} {relation} {relation_ver:?}",
        package_name = real_package.name,
        relation = found.name,
        relation_ver = found.version,
    );
    let dep_entry = reverse_deps.entry(kind).or_default();
    let package_entry = dep_entry.entry(real_package.clone()).or_default();
    package_entry.push(found);
}

fn handle_relations(
    relations: &Relations,
    package_name_regex: &Regex,
    reverse_deps: &mut BTreeMap<DepKind, BTreeMap<RealPackage, Vec<UnknownPackage>>>,
    package: &RealPackage,
    kind: DepKind,
) {
    relations
        .iter()
        .flatten()
        .filter_map(|r| map_relation(package_name_regex, r))
        .for_each(|found| handle_relation(reverse_deps, found, package, kind.clone()));
}

#[derive(Debug, Clone, Default)]
pub(crate) struct FoundPackages {
    pub(crate) source_packages: BTreeSet<RealPackage>,
    pub(crate) binary_packages: BTreeSet<RealPackage>,
    pub(crate) virtual_packages: HashSet<VirtualPackage>,
    pub(crate) reverse_depends: BTreeMap<DepKind, BTreeMap<RealPackage, Vec<UnknownPackage>>>,
}

#[tracing::instrument(skip(packages, sources))]
pub fn get_all_packages_for_crate(
    crate_name: &str,
    packages: &HashMap<(String, Version), Package>,
    sources: &HashMap<(String, Version), Source>,
) -> Result<FoundPackages, Error> {
    let package_name_re_str = format!(
        r"^librust-{crate_name}(?:-([0-9]+(?:\.[0-9]+(?:\.[0-9]+)?)?)?)?(\+[0-9a-zA-Z-]+)??-dev$"
    );
    let package_name_regex = Regex::new(&package_name_re_str.to_string())?;

    let source_package_name_re_str = format!(r"^rust-{crate_name}(?:-([0-9]+(?:\.[0-9]+)))?$");
    let source_package_name_regex = Regex::new(&source_package_name_re_str.to_string())?;

    let mut found_packages = FoundPackages::default();

    for ((package_name, version), package) in packages.iter() {
        let real_package = RealPackage {
            name: package_name.clone(),
            version: version.clone(),
            source: package.source.clone(),
            kind: PackageKind::Binary,
        };
        if package_name_regex.is_match(package_name) {
            info!("Found package {package_name}");
            found_packages.binary_packages.insert(real_package.clone());
        }
        if let Some(ref provides) = package.provides {
            for relation in provides.iter().flatten() {
                if package_name_regex.is_match(&relation.name) {
                    debug!("package {package_name} provides {relation}");
                    found_packages.virtual_packages.insert(VirtualPackage {
                        name: relation.name.clone(),
                        version: relation.version.clone(),
                        provider: real_package.clone(),
                    });
                }
            }
        }

        if let Some(ref depends) = package.depends {
            handle_relations(
                depends,
                &package_name_regex,
                &mut found_packages.reverse_depends,
                &real_package,
                DepKind::Depends,
            );
        }

        if let Some(ref pre_depends) = package.pre_depends {
            handle_relations(
                pre_depends,
                &package_name_regex,
                &mut found_packages.reverse_depends,
                &real_package,
                DepKind::PreDepends,
            );
        }

        if let Some(ref recommends) = package.recommends {
            handle_relations(
                recommends,
                &package_name_regex,
                &mut found_packages.reverse_depends,
                &real_package,
                DepKind::Recommends,
            );
        }

        if let Some(ref suggests) = package.suggests {
            handle_relations(
                suggests,
                &package_name_regex,
                &mut found_packages.reverse_depends,
                &real_package,
                DepKind::Suggests,
            );
        }

        if let Some(ref breaks) = package.breaks {
            handle_relations(
                breaks,
                &package_name_regex,
                &mut found_packages.reverse_depends,
                &real_package,
                DepKind::Breaks,
            );
        }

        if let Some(ref conflicts) = package.conflicts {
            handle_relations(
                conflicts,
                &package_name_regex,
                &mut found_packages.reverse_depends,
                &real_package,
                DepKind::Conflicts,
            );
        }

        if let Some(ref sbu) = package.static_built_using {
            // FIXME this likely switches to binary packages in the future
            handle_relations(
                sbu,
                &source_package_name_regex,
                &mut found_packages.reverse_depends,
                &real_package,
                DepKind::StaticBuiltUsing,
            );
        }
    }

    for ((source_name, version), source_package) in sources.iter() {
        let real_package = RealPackage {
            name: source_name.clone(),
            version: version.clone(),
            source: None,
            kind: PackageKind::Source,
        };
        if source_package_name_regex.is_match(source_name) {
            info!("Found source package {source_name}");
            found_packages.source_packages.insert(real_package.clone());
        }

        if let Some(ref build_depends) = source_package.build_depends {
            handle_relations(
                build_depends,
                &package_name_regex,
                &mut found_packages.reverse_depends,
                &real_package,
                DepKind::BuildDepends,
            );
        }

        if let Some(ref build_depends_arch) = source_package.build_depends_arch {
            handle_relations(
                build_depends_arch,
                &package_name_regex,
                &mut found_packages.reverse_depends,
                &real_package,
                DepKind::BuildDependsArch,
            );
        }

        if let Some(ref build_depends_indep) = source_package.build_depends_indep {
            handle_relations(
                build_depends_indep,
                &package_name_regex,
                &mut found_packages.reverse_depends,
                &real_package,
                DepKind::BuildDependsIndep,
            );
        }

        if let Some(ref build_conflicts) = source_package.build_conflicts {
            handle_relations(
                build_conflicts,
                &package_name_regex,
                &mut found_packages.reverse_depends,
                &real_package,
                DepKind::BuildConflicts,
            );
        }

        if let Some(ref build_conflicts_arch) = source_package.build_conflicts_arch {
            handle_relations(
                build_conflicts_arch,
                &package_name_regex,
                &mut found_packages.reverse_depends,
                &real_package,
                DepKind::BuildConflictsArch,
            );
        }

        if let Some(ref build_conflicts_indep) = source_package.build_conflicts_indep {
            handle_relations(
                build_conflicts_indep,
                &package_name_regex,
                &mut found_packages.reverse_depends,
                &real_package,
                DepKind::BuildConflictsIndep,
            );
        }

        if let Some(ref testsuite_triggers) = source_package.testsuite_triggers {
            for trigger in testsuite_triggers {
                if package_name_regex.is_match(trigger) {
                    let r = UnknownPackage {
                        name: trigger.clone(),
                        version: None,
                    };
                    handle_relation(
                        &mut found_packages.reverse_depends,
                        r,
                        &real_package,
                        DepKind::TestSuiteTriggers,
                    );
                }
            }
        }
    }
    let src_count = found_packages.source_packages.len();
    let bin_count = found_packages.binary_packages.len();
    info!(
        "Found {count} matching packages for {crate_name} (source: {src_count}, binary: {bin_count}.",
        count = src_count + bin_count,
    );
    info!(
        "Found {virtual_count} provided packages",
        virtual_count = found_packages.virtual_packages.len()
    );
    debug!("Packages: {found_packages:?}");
    Ok(found_packages)
}