@@ -28,6 +28,7 @@ use tar::{Archive, Builder, EntryType, Header, HeaderMode};
2828use tracing:: debug;
2929use unicase:: Ascii as UncasedAscii ;
3030
31+ #[ derive( Clone ) ]
3132pub struct PackageOpts < ' gctx > {
3233 pub gctx : & ' gctx GlobalContext ,
3334 pub list : bool ,
@@ -82,48 +83,39 @@ struct GitVcsInfo {
8283 sha1 : String ,
8384}
8485
86+ /// Packages a single package in a workspace, returning the resulting tar file.
87+ ///
88+ /// # Panics
89+ /// Panics if `opts.list` is true. In that case you probably don't want to
90+ /// actually build the package tarball; you should just make and print the list
91+ /// of files. (We don't currently provide a public API for that, but see how
92+ /// [`package`] does it.)
8593pub fn package_one (
8694 ws : & Workspace < ' _ > ,
8795 pkg : & Package ,
8896 opts : & PackageOpts < ' _ > ,
89- ) -> CargoResult < Option < FileLock > > {
90- let gctx = ws. gctx ( ) ;
91- let mut src = PathSource :: new ( pkg. root ( ) , pkg. package_id ( ) . source_id ( ) , gctx) ;
92- src. update ( ) ?;
97+ ) -> CargoResult < FileLock > {
98+ assert ! ( !opts. list) ;
9399
94- if opts. check_metadata {
95- check_metadata ( pkg, gctx) ?;
96- }
100+ let ar_files = prepare_archive ( ws, pkg, opts) ?;
101+ let tarball = create_package ( ws, pkg, ar_files) ?;
97102
98- if !pkg. manifest ( ) . exclude ( ) . is_empty ( ) && !pkg. manifest ( ) . include ( ) . is_empty ( ) {
99- gctx. shell ( ) . warn (
100- "both package.include and package.exclude are specified; \
101- ,
102- ) ?;
103+ if opts. verify {
104+ run_verify ( ws, pkg, & tarball, opts) ?;
103105 }
104- let src_files = src. list_files ( pkg) ?;
105106
106- // Check (git) repository state, getting the current commit hash if not
107- // dirty.
108- let vcs_info = if !opts. allow_dirty {
109- // This will error if a dirty repo is found.
110- check_repo_state ( pkg, & src_files, gctx) ?
111- } else {
112- None
113- } ;
114-
115- let ar_files = build_ar_list ( ws, pkg, src_files, vcs_info) ?;
107+ Ok ( tarball)
108+ }
116109
110+ // Builds a tarball and places it in the output directory.
111+ fn create_package (
112+ ws : & Workspace < ' _ > ,
113+ pkg : & Package ,
114+ ar_files : Vec < ArchiveFile > ,
115+ ) -> CargoResult < FileLock > {
116+ let gctx = ws. gctx ( ) ;
117117 let filecount = ar_files. len ( ) ;
118118
119- if opts. list {
120- for ar_file in ar_files {
121- drop_println ! ( gctx, "{}" , ar_file. rel_str) ;
122- }
123-
124- return Ok ( None ) ;
125- }
126-
127119 // Check that the package dependencies are safe to deploy.
128120 for dep in pkg. dependencies ( ) {
129121 super :: check_dep_has_version ( dep, false ) ?;
@@ -145,10 +137,6 @@ pub fn package_one(
145137 dst. file ( ) . set_len ( 0 ) ?;
146138 let uncompressed_size = tar ( ws, pkg, ar_files, dst. file ( ) , & filename)
147139 . with_context ( || "failed to prepare local package for uploading" ) ?;
148- if opts. verify {
149- dst. seek ( SeekFrom :: Start ( 0 ) ) ?;
150- run_verify ( ws, pkg, & dst, opts) . with_context ( || "failed to verify package tarball" ) ?
151- }
152140
153141 dst. seek ( SeekFrom :: Start ( 0 ) ) ?;
154142 let src_path = dst. path ( ) ;
@@ -172,7 +160,7 @@ pub fn package_one(
172160 // It doesn't really matter if this fails.
173161 drop ( gctx. shell ( ) . status ( "Packaged" , message) ) ;
174162
175- return Ok ( Some ( dst) ) ;
163+ return Ok ( dst) ;
176164}
177165
178166pub fn package ( ws : & Workspace < ' _ > , opts : & PackageOpts < ' _ > ) -> CargoResult < Option < Vec < FileLock > > > {
@@ -185,7 +173,6 @@ pub fn package(ws: &Workspace<'_>, opts: &PackageOpts<'_>) -> CargoResult<Option
185173 }
186174 }
187175 let pkgs = ws. members_with_features ( specs, & opts. cli_features ) ?;
188-
189176 let mut dsts = Vec :: with_capacity ( pkgs. len ( ) ) ;
190177
191178 if ws. root ( ) . join ( "Cargo.lock" ) . exists ( ) {
@@ -197,25 +184,24 @@ pub fn package(ws: &Workspace<'_>, opts: &PackageOpts<'_>) -> CargoResult<Option
197184 }
198185
199186 for ( pkg, cli_features) in pkgs {
200- let result = package_one (
201- ws,
202- pkg,
203- & PackageOpts {
204- gctx : opts. gctx ,
205- list : opts. list ,
206- check_metadata : opts. check_metadata ,
207- allow_dirty : opts. allow_dirty ,
208- verify : opts. verify ,
209- jobs : opts. jobs . clone ( ) ,
210- keep_going : opts. keep_going ,
211- to_package : ops:: Packages :: Default ,
212- targets : opts. targets . clone ( ) ,
213- cli_features : cli_features,
214- } ,
215- ) ?;
187+ let opts = PackageOpts {
188+ to_package : ops:: Packages :: Default ,
189+ cli_features,
190+ ..opts. clone ( )
191+ } ;
192+ let ar_files = prepare_archive ( ws, pkg, & opts) ?;
216193
217- if !opts. list {
218- dsts. push ( result. unwrap ( ) ) ;
194+ if opts. list {
195+ for ar_file in ar_files {
196+ drop_println ! ( ws. gctx( ) , "{}" , ar_file. rel_str) ;
197+ }
198+ } else {
199+ let tarball = create_package ( ws, pkg, ar_files) ?;
200+ if opts. verify {
201+ run_verify ( ws, pkg, & tarball, & opts)
202+ . with_context ( || "failed to verify package tarball" ) ?;
203+ }
204+ dsts. push ( tarball) ;
219205 }
220206 }
221207
@@ -227,6 +213,40 @@ pub fn package(ws: &Workspace<'_>, opts: &PackageOpts<'_>) -> CargoResult<Option
227213 }
228214}
229215
216+ /// Performs pre-archiving checks and builds a list of files to archive.
217+ fn prepare_archive (
218+ ws : & Workspace < ' _ > ,
219+ pkg : & Package ,
220+ opts : & PackageOpts < ' _ > ,
221+ ) -> CargoResult < Vec < ArchiveFile > > {
222+ let gctx = ws. gctx ( ) ;
223+ let mut src = PathSource :: new ( pkg. root ( ) , pkg. package_id ( ) . source_id ( ) , gctx) ;
224+ src. update ( ) ?;
225+
226+ if opts. check_metadata {
227+ check_metadata ( pkg, gctx) ?;
228+ }
229+
230+ if !pkg. manifest ( ) . exclude ( ) . is_empty ( ) && !pkg. manifest ( ) . include ( ) . is_empty ( ) {
231+ gctx. shell ( ) . warn (
232+ "both package.include and package.exclude are specified; \
233+ ,
234+ ) ?;
235+ }
236+ let src_files = src. list_files ( pkg) ?;
237+
238+ // Check (git) repository state, getting the current commit hash if not
239+ // dirty.
240+ let vcs_info = if !opts. allow_dirty {
241+ // This will error if a dirty repo is found.
242+ check_repo_state ( pkg, & src_files, gctx) ?
243+ } else {
244+ None
245+ } ;
246+
247+ build_ar_list ( ws, pkg, src_files, vcs_info)
248+ }
249+
230250/// Builds list of files to archive.
231251fn build_ar_list (
232252 ws : & Workspace < ' _ > ,
@@ -236,7 +256,6 @@ fn build_ar_list(
236256) -> CargoResult < Vec < ArchiveFile > > {
237257 let mut result = HashMap :: new ( ) ;
238258 let root = pkg. root ( ) ;
239-
240259 for src_file in & src_files {
241260 let rel_path = src_file. strip_prefix ( & root) ?;
242261 check_filename ( rel_path, & mut ws. gctx ( ) . shell ( ) ) ?;
0 commit comments