willbe 0.34.0

Utility to publish multi-crate and multi-workspace environments and maintain their consistency.
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
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
mod private
{

  use crate :: *;

  use std ::
  {
  fs ::File,
  io :: { Write, Read },
 };

  use std ::path ::Path;
  use collection_tools ::collection ::BTreeMap;
  use convert_case :: { Casing, Case };
  use handlebars :: { RenderError, TemplateError };
  use toml_edit ::Document;

  use entity :: { PathError, WorkspaceInitError };
  // Explicit import for Result and its variants for pattern matching
  use core ::result ::Result :: { Ok, Err };

  use error ::
  {
  typed ::Error,
  // err,
 };

  #[ derive( Debug, Error ) ]
  pub enum CiCdGenerateError
  {
  // qqq: rid of the branch
  #[ error( "Common error: {0}" ) ]
  Common( #[ from ] error ::untyped ::Error ),
  #[ error( "I/O error: {0}" ) ]
  IO( #[ from ] std ::io ::Error ),
  #[ error( "Crate directory error: {0}" ) ]
  CrateDir( #[ from ] PathError ),
  #[ error( "Workspace error: {0}" ) ]
  Workspace( #[ from ] WorkspaceInitError ),
  #[ error( "Template error: {0}" ) ]
  Template( #[ from ] TemplateError ),
  #[ error( "Render error: {0}" ) ]
  Render( #[ from ] RenderError ),
 }

  // qqq: for Petro: should return Report and typed error in Result
  /// Generate workflows for modules in .github/workflows directory.
  /// # Errors
  /// qqq: doc
  ///
  /// # Panics
  /// qqq: doc
  #[ allow( clippy ::too_many_lines, clippy ::result_large_err ) ]
  pub fn action( base_path: &Path ) -> Result< (), CiCdGenerateError >
  {
  let workspace_cache = Workspace ::try_from( CrateDir ::try_from( base_path )? )?;
  let packages = workspace_cache.packages();
  let username_and_repository = &username_and_repository
  (
   &workspace_cache.workspace_root().join( "Cargo.toml" )?.to_path_buf().try_into()?, // qqq
   packages.clone(),
   // packages.as_slice(),
 )?;
  let workspace_root: &Path = &workspace_cache.workspace_root();
  // find directory for workflows
  let workflow_root = workspace_root.join( ".github" ).join( "workflows" );
  // map packages name's to naming standard
  // let names = packages.map( | p | p.name() ).collect :: < Vec< _ > >();
  let names = packages.clone().map( | p | p.name().to_string() );

  // dbg!( &workflow_root );

  // map packages path to relative paths fom workspace root,
  // for example D: /work/wTools/module/core/iter_tools => module/core/iter_tools
  let relative_paths = packages
  .map( | p | p.manifest_file().ok() ) // aaa: rid of unwrap: removed
  .filter_map( | p |
  {
   // dbg!( &workspace_root );
   Some( path ::normalize( workspace_root ) ).and_then( | root_str |
   {

  dbg!( &root_str );
  dbg!( &p );

  Some( p?.strip_prefix( root_str ).ok()?.to_path_buf() )
  //.map( | s | s.display().to_string() ).ok()
 })
 })
  .map( | p |
  {
   path ::normalize( p.parent().unwrap() )
   // dbg!( &p );
   // let mut path = PathBuf ::from( p );
   // path.set_file_name( "" );
   // path
 });

  // preparing templates
  let mut handlebars = handlebars ::Handlebars ::new();

  handlebars.register_template_string
  (
   "auto_pr_to",
   include_str!( "../../template/workflow/auto_pr_to.hbs" )
 )?;
  handlebars.register_template_string
  (
   "appropraite_branch_for",
   include_str!( "../../template/workflow/appropraite_branch_for.hbs" )
 )?;
  handlebars.register_template_string
  (
   "auto_merge_to",
   include_str!( "../../template/workflow/auto_merge_to.hbs" )
 )?;
  handlebars.register_template_string
  (
   "standard_rust_pull_request",
   include_str!( "../../template/workflow/standard_rust_pull_request.hbs" )
 )?;
  handlebars.register_template_string
  (
   "module_push",
   include_str!( "../../template/workflow/module_push.hbs" )
 )?;

  // qqq: for Petro: instead of iterating each file manually, iterate each file in loop

  // use similar ::DiffableStr;

  // creating workflow for each module
  for ( name, relative_path ) in names.zip( relative_paths )
  {
   // generate file names
   let workflow_file_name = workflow_root
   .join( format!( "module_{}_push.yml", name.to_case( Case ::Snake ) ) );
   let manifest_file = relative_path.join( "Cargo.toml" );
   let mut data: BTreeMap< &str, &str > = BTreeMap ::new();
   data.insert( "name", name.as_str() );
   data.insert( "username_and_repository", username_and_repository.0.as_str() );
   data.insert( "branch", "alpha" );
   let manifest_file = manifest_file.to_string_lossy().replace( '\\', "/" );
   let manifest_file = manifest_file.trim_start_matches( '/' );
   data.insert( "manifest_path", manifest_file );
   let content = handlebars.render( "module_push", &data )?;
   file_write( &workflow_file_name, &content )?;

   println!( "file_write: {}", &workflow_file_name.display() );
 }

  dbg!( &workflow_root );

  file_write
  (
   &workflow_root
   .join("appropriate_branch.yml" ),
   include_str!( "../../template/workflow/appropriate_branch.yml" )
 )?;

  let data = map_prepare_for_appropriative_branch
  (
   "- beta",
   username_and_repository.0.as_str(),
   "alpha",
   "alpha",
   "beta"
 );
  file_write
  (
   &workflow_root.join( "appropriate_branch_beta.yml" ),
   &handlebars.render( "appropraite_branch_for", &data )?
 )?;

  let data = map_prepare_for_appropriative_branch
  (
   "- main\n      - master",
   username_and_repository.0.as_str(),
   "alpha",
   "beta",
   "master"
 );

  file_write
  (
   &workflow_root.join( "appropriate_branch_master.yml" ),
   &handlebars.render( "appropraite_branch_for", &data )?
 )?;

  let mut data = BTreeMap ::new();
  data.insert( "name", "beta" );
  data.insert( "group_branch", "beta" );
  data.insert( "branch", "alpha" );

  file_write
  (
   &workflow_root.join( "auto_merge_to_beta.yml" ),
   &handlebars.render( "auto_merge_to", &data )?
 )?;
  file_write
  (
   &workflow_root.join( "auto_pr.yml" ),
   include_str!( "../../template/workflow/auto_pr.yml" )
 )?;

  let mut data = BTreeMap ::new();
  data.insert( "name", "alpha" );
  data.insert
  (
   "branches",
   " - '*'
   - '*/*'
   - '**'
   - '!master'
   - '!main'
   - '!alpha'
   - '!beta'
   - '!*test*'
   - '!*test*/*'
   - '!*/*test*'
   - '!*experiment*'
   - '!*experiment*/*'
   - '!*/*experiment*'"
 );
  data.insert( "username_and_repository", username_and_repository.0.as_str() );
  data.insert( "uses_branch", "alpha" );
  data.insert( "src_branch", "${{ github.ref_name }}" );
  data.insert( "dest_branch", "alpha" );

  file_write
  (
   &workflow_root.join( "auto_pr_to_alpha.yml" ),
   &handlebars.render( "auto_pr_to", &data )?
 )?;

  let mut data = BTreeMap ::new();
  data.insert( "name", "beta" );
  data.insert( "branches",  "- alpha" );
  data.insert( "username_and_repository", username_and_repository.0.as_str() );
  data.insert( "uses_branch", "alpha" );
  data.insert( "src_branch", "alpha" );
  data.insert( "dest_branch", "beta" );

  file_write
  (
   &workflow_root.join( "auto_pr_to_beta.yml" ),
   &handlebars.render( "auto_pr_to", &data )?
 )?;

  let mut data = BTreeMap ::new();
  data.insert( "name", "master" );
  data.insert( "branches",  "- beta" );
  data.insert( "username_and_repository", username_and_repository.0.as_str() );
  data.insert( "uses_branch", "alpha" );
  data.insert( "src_branch", "beta" );
  data.insert( "dest_branch", "master" );

  file_write
  (
   &workflow_root.join( "auto_pr_to_master.yml" ),
   &handlebars.render( "auto_pr_to", &data )?
 )?;

  file_write
  (
   &workflow_root.join( "runs_clean.yml" ),
   include_str!( "../../template/workflow/rust_clean.yml" )
 )?;

  let mut data = BTreeMap ::new();
  data.insert( "username_and_repository", username_and_repository.0.as_str() );

  file_write
  (
   &workflow_root.join( "standard_rust_pull_request.yml" ),
   &handlebars.render( "standard_rust_pull_request", &data )?
 )?;

  file_write
  (
   &workflow_root.join( "standard_rust_push.yml" ),
   include_str!( "../../template/workflow/standard_rust_push.yml" )
 )?;

  file_write
  (
   &workflow_root.join( "for_pr_rust_push.yml" ),
   include_str!( "../../template/workflow/for_pr_rust_push.yml" )
 )?;

  file_write
  (
   &workflow_root.join( "standard_rust_scheduled.yml" ),
   include_str!( "../../template/workflow/standard_rust_scheduled.yml" )
 )?;

  file_write
  (
   &workflow_root.join( "standard_rust_status.yml" ),
   include_str!( "../../template/workflow/standard_rust_status.yml" )
 )?;

  file_write
  (
   &workflow_root.join( "status_checks_rules_update.yml" ),
   include_str!( "../../template/workflow/status_checks_rules_update.yml" )
 )?;

  file_write
  (
   &workflow_root.join( "readme.md" ),
   include_str!( "../../template/workflow/readme.md" )
 )?;

  Ok :: < _, CiCdGenerateError >( () )
 }

  /// Prepare params for render `appropriative_branch_for` template.
  fn map_prepare_for_appropriative_branch< 'a >
  (
  branches: &'a str,
  username_and_repository: &'a str,
  uses_branch: &'a str,
  src_branch: &'a str,
  name: &'a str
 )
  -> BTreeMap< &'a str, &'a str >
  {
  let mut data = BTreeMap ::new();
  data.insert( "branches", branches );
  data.insert( "username_and_repository", username_and_repository );
  data.insert( "uses_branch", uses_branch );
  data.insert( "src_branch", src_branch );
  data.insert( "name", name );
  data
 }

  /// Create and write or rewrite content in file.
  pub fn file_write( filename: &Path, content: &str ) -> error ::untyped ::Result< () > // qqq: use typed error
  {
  if let Some( folder ) = filename.parent()
  {
   match std ::fs ::create_dir_all( folder )
   {
  Ok( () ) => {},
  Err( e ) if e.kind() == std ::io ::ErrorKind ::AlreadyExists => {},
  Err( e ) => return Err( e.into() ),
 }
 }

  let mut file = File ::create( filename )?;
  file.write_all( content.as_bytes() )?;
  Ok( () )
 }

  #[ derive( Debug ) ]
  struct UsernameAndRepository( String );

  /// Searches and extracts the username and repository name from the repository URL.
  /// The repository URL is first sought in the Cargo.toml file of the workspace;
  /// if not found there, it is then searched in the Cargo.toml file of the module.
  /// If it is still not found, the search continues in the GitHub remotes.
  /// Result looks like this: `Wandalen/wTools`
  fn username_and_repository< 'a >
  (
  cargo_toml_path: &AbsolutePath,
  packages: impl Iterator< Item = WorkspacePackageRef< 'a > >,
 )
  -> error ::untyped ::Result< UsernameAndRepository >
  // qqq: use typed error
  {
   let mut contents = String ::new();
   File ::open( cargo_toml_path )?.read_to_string( &mut contents )?;
   let doc = contents.parse :: < Document >()?;
   let url =
   doc
   .get( "workspace" )
   .and_then( | workspace  | workspace.get( "metadata" ) )
   .and_then( | metadata | metadata.get( "repo_url" ) )
   .and_then( | url | url.as_str() )
   .map( String ::from );
   if let Some( url ) = url
   {
  url ::repo_url_extract( &url )
  .and_then( | url | url ::git_info_extract( &url ).ok() )
  .map( UsernameAndRepository )
  .ok_or_else( || error ::untyped ::format_err!( "Fail to parse repository url from workspace Cargo.toml") )
 }
   else
   {
  let mut url = None;
  for package in packages
  {
   // if let Ok( wu ) = manifest ::private ::repo_url( package.manifest_file().parent().unwrap().as_std_path() )
   if let Ok( wu ) = manifest ::repo_url( &package.crate_dir()? )
   {
  url = Some( wu );
  break;
 }
 }
  url
  .as_ref()
  .and_then( | url | url ::repo_url_extract( url ) )
  .and_then( | url | url ::git_info_extract( &url ).ok() )
  .map( UsernameAndRepository )
  .ok_or_else( || error ::untyped ::format_err!( "Fail to extract repository url") )
 }
 }

}

crate ::mod_interface!
{
  own use action;
}