gen-orb-mcp 0.1.9

Generate MCP servers from CircleCI orb definitions
Documentation 
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

//! Human-readable formatting of migration plans.

use super::types::{ChangeType, MigrationPlan, PlannedChange};

impl MigrationPlan {
    /// Returns a human-readable summary of the migration plan.
    pub fn format_summary(&self) -> String {
        if self.changes.is_empty() {
            return format!(
                "No migration required: all files already conform to {}@{}",
                self.orb, self.target_version
            );
        }

        let mut lines = Vec::new();
        lines.push(format!(
            "Migration plan: {} → {}",
            self.orb, self.target_version
        ));
        if self.detected_version != "unknown" {
            lines.push(format!("  Detected version: {}", self.detected_version));
        }
        lines.push(format!("  Changes: {}", self.changes.len()));
        lines.push(String::new());

        // Group changes by file
        let mut by_file: std::collections::BTreeMap<String, Vec<&PlannedChange>> =
            std::collections::BTreeMap::new();
        for change in &self.changes {
            by_file
                .entry(change.file.display().to_string())
                .or_default()
                .push(change);
        }

        for (file, changes) in &by_file {
            lines.push(format!("  {}:", file));
            for change in changes {
                lines.push(format!("    • {}", change.description));
                if !change.before.is_empty() || !change.after.is_empty() {
                    lines.push(format!("      Before: {}", change.before));
                    lines.push(format!("      After:  {}", change.after));
                }
            }
        }

        lines.join("\n")
    }
}

impl PlannedChange {
    /// Returns a short one-line description of this change.
    pub fn short_description(&self) -> String {
        match &self.change_type {
            ChangeType::RemoveJobInvocation { workflow, job_ref } => {
                format!("Remove `{job_ref}` from workflow `{workflow}`")
            }
            ChangeType::RenameJobInvocation { workflow, from, to } => {
                format!("Rename `{from}` → `{to}` in workflow `{workflow}`")
            }
            ChangeType::RemoveParameter {
                workflow,
                job_ref,
                parameter,
            } => {
                format!("Remove parameter `{parameter}` from `{job_ref}` in `{workflow}`")
            }
            ChangeType::ReplaceParameterValue {
                workflow,
                job_ref,
                parameter,
                replacement,
            } => {
                format!(
                    "Replace value of `{parameter}` on `{job_ref}` with `{replacement}` in `{workflow}`"
                )
            }
            ChangeType::RemoveCommandInvocation { job, command_ref } => {
                format!("Remove command `{command_ref}` from job `{job}`")
            }
            ChangeType::RenameCommandInvocation { job, from, to } => {
                format!("Rename command `{from}` → `{to}` in job `{job}`")
            }
            ChangeType::RemoveCommandParameter {
                job,
                command_ref,
                parameter,
            } => {
                format!("Remove parameter `{parameter}` from `{command_ref}` in job `{job}`")
            }
            ChangeType::RemovePipelineParameter { parameter } => {
                format!("Remove orphaned pipeline parameter `{parameter}` from `parameters:` block")
            }
            ChangeType::UpdateOrbVersion {
                orb_alias,
                from_version,
                to_version,
            } => {
                format!("Update orb pin `{orb_alias}` from `{from_version}` to `{to_version}`")
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use std::path::PathBuf;

    use crate::migrator::types::{ChangeType, MigrationPlan, PlannedChange};

    #[test]
    fn test_format_summary_no_changes() {
        let plan = MigrationPlan {
            orb: "toolkit".to_string(),
            target_version: "5.0.0".to_string(),
            detected_version: "5.0.0".to_string(),
            changes: vec![],
        };
        let summary = plan.format_summary();
        assert!(summary.contains("No migration required"));
    }

    #[test]
    fn test_format_summary_with_changes() {
        let plan = MigrationPlan {
            orb: "toolkit".to_string(),
            target_version: "5.0.0".to_string(),
            detected_version: "4.8.0".to_string(),
            changes: vec![PlannedChange {
                file: PathBuf::from("update_prlog.yml"),
                description: "Remove label job".to_string(),
                change_type: ChangeType::RemoveJobInvocation {
                    workflow: "update_prlog".to_string(),
                    job_ref: "toolkit/label".to_string(),
                },
                before: "- toolkit/label".to_string(),
                after: String::new(),
            }],
        };
        let summary = plan.format_summary();
        assert!(summary.contains("Migration plan"));
        assert!(summary.contains("5.0.0"));
        assert!(summary.contains("update_prlog.yml"));
    }
}