Changeset 1850 in ProjectBuilder for devel/pb-modules/lib/ProjectBuilder/VCS.pm

Timestamp:

Jan 28, 2014, 9:10:25 AM (10 years ago)

Author:

Bruno Cornec

Message:

• Move pb_cms_compliant fundtion into VCS.pm and rename it pb_vcs_compliant, as it was used incorrectly in Env.pm which was lower in the tree. Detected by MondoRescue 3.2 update by Corey Wirun and reported on the ML.

File:

• devel/pb-modules/lib/ProjectBuilder/VCS.pm (modified) (2 diffs)

devel/pb-modules/lib/ProjectBuilder/VCS.pm

@@ -36 +36 @@
  
 our @ISA = qw(Exporter);
-our @EXPORT = qw(pb_vcs_export pb_vcs_get_uri pb_vcs_copy pb_vcs_checkout pb_vcs_up pb_vcs_checkin pb_vcs_isdiff pb_vcs_add pb_vcs_add_if_not_in pb_vcs_cmd);
+our @EXPORT = qw(pb_vcs_export pb_vcs_get_uri pb_vcs_copy pb_vcs_checkout pb_vcs_up pb_vcs_checkin pb_vcs_isdiff pb_vcs_add pb_vcs_add_if_not_in pb_vcs_cmd pb_vcs_compliant);
 ($VERSION,$REVISION) = pb_version_init();
 
@@ -623 +623 @@
 }
 
-    
+=item B<pb_vcs_compliant>
+
+This function checks the compliance of the project and the pbconf directory.
+The first parameter is the key name of the value that needs to be read in the configuration file.
+The second parameter is the environment variable this key will populate.
+The third parameter is the location of the pbconf dir.
+The fourth parameter is the URI of the CMS content related to the pbconf dir.
+The fifth parameter indicates whether we should inititate the context or not.
+
+=cut
+
+sub pb_vcs_compliant {
+
+my $param = shift;
+my $envar = shift;
+my $defdir = shift;
+my $uri = shift;
+my $pbinit = shift;
+my %pdir;
+
+pb_log(1,"pb_vcs_compliant: envar: $envar - defdir: $defdir - uri: $uri\n");
+my ($pdir) = pb_conf_get_if($param) if (defined $param);
+if (defined $pdir) {
+    %pdir = %$pdir;
+}
+
+
+if ((defined $pdir) && (%pdir) && (defined $pdir{$ENV{'PBPROJ'}})) {
+    # That's always the environment variable that will be used
+    $ENV{$envar} = $pdir{$ENV{'PBPROJ'}};
+} else {
+    if (defined $param) {
+        pb_log(1,"WARNING: no $param defined, using $defdir\n");
+        pb_log(1,"         Please create a $param reference for project $ENV{'PBPROJ'} in $ENV{'PBETC'}\n");
+        pb_log(1,"         if you want to use another directory\n");
+    }
+    $ENV{$envar} = "$defdir";
+}
+
+# Expand potential env variable in it
+eval { $ENV{$envar} =~ s/(\$ENV.+\})/$1/eeg };
+pb_log(2,"$envar: $ENV{$envar}\n");
+
+my ($scheme, $account, $host, $port, $path) = pb_get_uri($uri);
+
+if (($scheme !~ /^cvs/) && ($scheme !~ /^svn/) && ($scheme !~ /^svk/) && ($scheme !~ /^hg/) && ($scheme !~ /^git/)) {
+    # Do not compare if it's not a real cms
+    pb_log(1,"pb_vcs_compliant useless\n");
+    return;
+} elsif (defined $pbinit) {
+    pb_mkdir_p("$ENV{$envar}");
+} elsif (! -d "$ENV{$envar}") {
+    # Either we have a version in the uri, and it should be the same
+    # as the one in the envar. Or we should add the version to the uri
+    if (basename($uri) ne basename($ENV{$envar})) {
+        $uri .= "/".basename($ENV{$envar})
+    }
+    pb_log(1,"Checking out $uri\n");
+    # Create structure and remove end dir before exporting
+    pb_mkdir_p("$ENV{$envar}");
+    pb_rm_rf($ENV{$envar});
+    pb_vcs_checkout($scheme,$uri,$ENV{$envar});
+} else {
+    pb_log(1,"$uri found locally, checking content\n");
+    my $cmsurl = pb_vcs_get_uri($scheme,$ENV{$envar});
+    my ($scheme2, $account2, $host2, $port2, $path2) = pb_get_uri($cmsurl);
+    # For svk, scheme doesn't appear in svk info so remove it here in uri coming from conf file 
+    # which needs it to trigger correct behaviour
+    $uri =~ s/^svk://;
+    if (($scheme2 =~ /^git/) || ($scheme2 =~ /^hg/)) {
+        # These VCS manage branches internally not with different tree structures
+        # Assuming it's correct for now.
+    } elsif ($cmsurl ne $uri) {
+        # The local content doesn't correpond to the repository
+        pb_log(0,"ERROR: Inconsistency detected:\n");
+        pb_log(0,"       * $ENV{$envar} ($envar) refers to $cmsurl but\n");
+        pb_log(0,"       * $ENV{'PBETC'} refers to $uri\n");
+        die "Project $ENV{'PBPROJ'} is not Project-Builder compliant.";
+    } else {
+        pb_log(1,"Content correct - doing nothing - you may want to update your repository however\n");
+        # they match - do nothing - there may be local changes
+    }
+}
+pb_log(1,"pb_vcs_compliant end\n");
+}
+
 
 =back