ST6RI-178 Added basic branching capability

Author: TheKorpos

org.omg.kerml.xtext/src/org/omg/kerml/xtext/util/KerML2JSON.java

@@ -29,6 +29,12 @@
 import java.util.Arrays;
 import java.util.Date;
 
+import org.apache.commons.cli.CommandLine;
+import org.apache.commons.cli.CommandLineParser;
+import org.apache.commons.cli.DefaultParser;
+import org.apache.commons.cli.Option;
+import org.apache.commons.cli.Options;
+import org.apache.commons.cli.ParseException;
 import org.omg.sysml.lang.sysml.util.SysMLLibraryUtil;
 import org.omg.sysml.util.traversal.facade.impl.ApiElementProcessingFacade;
 
@@ -46,6 +52,7 @@ public class KerMLRepositorySaveUtil extends KerMLTraversalUtil {
 	private boolean isAddDerivedElements = false;
 	private boolean isAddImplicitElements = false;
 	private String projectName;
+	private String branchName; 
 	private boolean isCommitted = false;
 
 	public KerMLRepositorySaveUtil() {
@@ -116,30 +123,50 @@ public boolean isCommitted() {
 	 *          prepended to arguments for library model files.
 	 */
 	protected String[] processArgs(String[] args) {
-		int n = args.length;
-		if (n > 0) {
-			int i = 0;
-			while(("-b".equals(args[i]) || "-l".equals(args[i]) || "-d".equals(args[i]) ||
-				   "-g".equals(args[i]) || "-v".equals(args[i])) && 
-					i + 1 < n) {
-				if ("-b".equals(args[i])) {
-					this.basePath = args[++i];
-				} else if ("-l".equals(args[i])) {
-					this.libraryPath = args[++i];
-					if (!libraryPath.endsWith("/")) {
-						libraryPath += "/";
-					}
-				} else if ("-d".equals(args[i])) {
-					this.isAddDerivedElements = true;
-				} else if ("-g".equals(args[i])) {
-					this.isAddImplicitElements = true;
-				} else if ("-v".equals(args[i])) {
-					this.setVerbose(true);
-				}
-				i++;
+		var libraryPathOption = new Option("l", true, "gives the base path to used for reading model library resources");
+		var basePathOption = new Option("b", true, "");
+		var isVerboseOption = new Option("v", false, "");
+		var addImplicitsOption = new Option("g", "");
+		var addDerivedOption = new Option("d", "");
+		var projectOption = new Option("p", true, "");
+		var branchOption = new Option("br", true, "");
+		
+		libraryPathOption.setRequired(true);
+		basePathOption.setRequired(true);
+		isVerboseOption.setRequired(false);
+		addImplicitsOption.setRequired(false);
+		addDerivedOption.setRequired(false);
+		branchOption.setRequired(false);
+		projectOption.setRequired(false);
+		
+		Options options = new Options()
+				.addOption(libraryPathOption)
+				.addOption(basePathOption)
+				.addOption(isVerboseOption)
+				.addOption(addImplicitsOption)
+				.addOption(addDerivedOption)
+				.addOption(projectOption)
+				.addOption(branchOption);
+		
+		CommandLineParser parser = new DefaultParser();
+		
+		try {
+			CommandLine cli = parser.parse(options, args);
+			basePath = cli.getOptionValue(basePathOption);
+			libraryPath = cli.getOptionValue(libraryPathOption);
+			if (!libraryPath.endsWith("/")) {
+				libraryPath += "/";
 			}
-			if (i < n) {
-				args = Arrays.copyOfRange(args, i, n);
+			isAddImplicitElements = cli.hasOption(addImplicitsOption);
+			isAddDerivedElements = cli.hasOption(addDerivedOption);
+			setVerbose(cli.hasOption(isVerboseOption));
+			projectName = cli.getOptionValue(projectOption);
+			branchName = cli.getOptionValue(branchOption);
+			
+			args = cli.getArgs();
+			
+			if (args.length > 0) {
+				args = Arrays.copyOf(args, args.length);
 
 				if (this.libraryPath != null) {
 					for (int k = 1; k < args.length; k++) {
@@ -149,7 +176,10 @@ protected String[] processArgs(String[] args) {
 
 				return args;
 			}
+		} catch (ParseException e) {
+			System.err.println(e.getMessage());
 		}
+		
 		return null;
 	}
 
@@ -166,14 +196,16 @@ protected void initialize(String[] args)  {
 			SysMLLibraryUtil.setModelLibraryDirectory(libraryPath);
 		}
 
-		this.projectName = Paths.get(args[0]).getFileName().toString();
-		int j = this.projectName.indexOf('.');
-		if (j >= 0) {
-			this.projectName = this.projectName.substring(0, j);
+		if (this.projectName == null) {
+			this.projectName = Paths.get(args[0]).getFileName().toString();
+			int j = this.projectName.indexOf('.');
+			if (j >= 0) {
+				this.projectName = this.projectName.substring(0, j);
+			}
+			this.projectName += " " + new Date();
 		}
-		this.projectName += " " + new Date();
 
-		ApiElementProcessingFacade processingFacade = new ApiElementProcessingFacade(this.projectName, this.getBasePath());	
+		ApiElementProcessingFacade processingFacade = new ApiElementProcessingFacade(this.projectName, branchName, this.getBasePath());	
 		processingFacade.setTraversal(this.initialize(processingFacade));
 		processingFacade.setIsVerbose(this.isVerbose());
 		processingFacade.setIsIncludeDerived(this.isAddDerivedElements);
@@ -197,7 +229,6 @@ public void run(String[] args) {
 		args = this.processArgs(args);
 
 		if (args != null) {
-			
 			System.out.println("Saving " + args[0] + "...");
 
 			this.initialize(args);				
@@ -211,7 +242,12 @@ public void run(String[] args) {
 			System.out.println();
 
 			this.process();
-			System.out.println("Saved to Project (" + this.getProjectName() + ") " + this.getProjectId());
+			
+			if (isCommitted()) {
+				System.out.println("Saved to Project (" + this.getProjectName() + ") " + this.getProjectId());
+			} else {
+				System.out.println("Failed to save Project (" + this.getProjectName() + ") ");
+			}
 			System.out.println();
 		}
 	}

org.omg.kerml.xtext/src/org/omg/kerml/xtext/util/KerMLRepositorySaveUtil.java

@@ -59,7 +59,6 @@
 import org.omg.kerml.xtext.KerMLStandaloneSetup;
 import org.omg.kerml.xtext.library.ILibraryIndexProvider;
 import org.omg.kerml.xtext.naming.KerMLQualifiedNameConverter;
-import org.omg.sysml.ApiException;
 import org.omg.sysml.execution.expressions.ExpressionEvaluator;
 import org.omg.sysml.lang.sysml.Element;
 import org.omg.sysml.lang.sysml.Expression;
@@ -365,7 +364,7 @@ public Object show(String name, List<String> styles, List<String> help) {
 			else if (matchStyle(styles, "JSON")) {
 				JsonElementProcessingFacade processingFacade = this.getJsonElementProcessingFacade();
 				processingFacade.getTraversal().visit(element);
-				return processingFacade.toJsonTree();
+				return processingFacade.toJsonTree(true);
 			}
 			else if (styles.isEmpty() || matchStyle(styles, "TREE")){
 				return SysMLInteractiveUtil.formatTree(element);
@@ -389,7 +388,7 @@ public Object export(String name, List<String> help) {
 			}
 			JsonElementProcessingFacade processingFacade = this.getJsonElementProcessingFacade();
 			processingFacade.getTraversal().visit(element);
-			return processingFacade.toJsonTree();
+			return processingFacade.toJsonTree(true);
 		} catch (Exception e) {
 			return SysMLInteractiveUtil.formatException(e);
 		}
@@ -409,7 +408,7 @@ public String show(String name) {
 				show(name, Collections.emptyList(), Collections.emptyList()));
 	}
 
-	public String publish(String elementName, String projectName, List<String> help) {
+	public String publish(String elementName, String projectName, String branchName, List<String> help) {
 		this.counter++;
 		if (Strings.isNullOrEmpty(elementName)) {
 			return help.isEmpty()? "": SysMLInteractiveHelp.getPublishHelp();
@@ -423,7 +422,7 @@ public String publish(String elementName, String projectName, List<String> help)
 			} else {
 				String remoteProjectName = projectName == null? element.getDeclaredName() + " " + new Date() : projectName;
 
-				ApiElementProcessingFacade processingFacade = this.getApiElementProcessingFacade(remoteProjectName);
+				ApiElementProcessingFacade processingFacade = this.getApiElementProcessingFacade(remoteProjectName, branchName);
 				processingFacade.getTraversal().visit(element);
 				processingFacade.commit(element);
 				System.out.println();
@@ -436,11 +435,11 @@ public String publish(String elementName, String projectName, List<String> help)
 
 	protected String publish(String name) {
 		return "-h".equals(name)? 
-				publish(null, null, Collections.singletonList("true")):
-				publish(name, null, Collections.emptyList());
+				publish(null, null, null, Collections.singletonList("true")):
+				publish(name, null, null, Collections.emptyList());
 	}
 
-	public String loadByName(String projectName, List<String> help) {
+	public String loadByName(String projectName, String branchName, List<String> help) {
 		if (Strings.isNullOrEmpty(projectName)) {
 			return help.isEmpty()? "": SysMLInteractiveHelp.getLoadHelp();
 		}
@@ -454,75 +453,94 @@ public String loadByName(String projectName, List<String> help) {
 			return "ERROR:Project doesn't exist.";
 		}
 
-		return load(repositoryProject);
+		return load(repositoryProject, branchName);
 	}
 
-	public String loadById(String projectId, List<String> help) {
+	public String loadById(String projectId, String branchId, List<String> help) {
 		if (Strings.isNullOrEmpty(projectId)) {
 			return help.isEmpty()? "": SysMLInteractiveHelp.getLoadHelp();
 		}
 
 		ProjectRepository repository = new ProjectRepository(apiBasePath);
 
 		System.out.println("Locating model");
-		RemoteProject repositoryProject = repository.getPRojectById(UUID.fromString(projectId));
+		RemoteProject remoteProject = repository.getPRojectById(UUID.fromString(projectId));
 
-		if (repositoryProject == null) {
+		if (remoteProject == null) {
 			return "ERROR:Project doesn't exist.";
 		}
 
-		return load(repositoryProject);
+		if (branchId == null) {
+			return load(remoteProject, (UUID) null);
+		} else {
+			UUID branchUUID = UUID.fromString(branchId);
+			return load(remoteProject, branchUUID);
+		}
+	}
+	
+	private String load(RemoteProject remoteProject, String branchName) {
+		final RemoteBranch branch;
+		if (branchName == null) {
+			branch = remoteProject.getDefaultBranch();
+		} else {
+			branch = remoteProject.getBranch(branchName);
+		}
+		return load(branch);
+	}
+	
+	private String load(RemoteProject remoteProject, UUID branchId) {
+		final RemoteBranch branch;
+		if (branchId == null) {
+			branch = remoteProject.getDefaultBranch();
+		} else {
+			branch = remoteProject.getBranch(branchId);
+		}
+		return load(branch);
 	}
 
-	private String load(RemoteProject repositoryProject) {
-		try {
-			RemoteBranch defaultBranch = repositoryProject.getDefaultBranch();
-			Revision headRevision = defaultBranch.getHeadRevision();
-			APIModel model = headRevision.fetchRemote();
-			
-			System.out.println("Collecting UUIDs...");
-			if (!tracker.isLibraryTracked()) {
-				tracker.trackLibraryUUIDs(getLibraryResources());
-			}
-			
-			tracker.clear();
-			List<Resource> inputResources = getInputResources();
-			//UUIDS coming from resources that were added later in time will shadow previous ones
-			tracker.trackLocalUUIDs(inputResources);
-			
-			EMFModelRefresher fetcher = new EMFModelRefresher(model, tracker);
-			
-			System.out.println("Downloading model...");
-			EMFModelDelta delta = fetcher.create();
-			
-			System.out.println("Adding model to index");
-			delta.getProjectRoots().forEach((eObject, dto) -> {
-				next(SYSMLX_EXTENSION);
-				Resource xmiResource = getResource();
-				if (eObject instanceof Namespace) {
-					xmiResource.getContents().add(eObject);
-				} else {
-					Namespace root = SysMLFactory.eINSTANCE.createNamespace();
-					NamespaceUtil.addOwnedMemberTo(root, (Element) eObject);
-					xmiResource.getContents().add(root);
-				}
-				addResourceToIndex(xmiResource);
-			});
-			
-			return "Project loaded: " + repositoryProject.getProjectName() + ", " + repositoryProject.getRemoteId().toString();
-		} catch (NoSuchElementException e) {
-			e.printStackTrace();
-			return "Requested model doesn't exist.";
-		} catch (ApiException e) {
-			e.printStackTrace();
-			return "Error occured while trying to load model";
+	private String load(RemoteBranch branch) {
+		RemoteProject remoteProject = branch.getRemoteProject();
+		Revision headRevision = branch.getHeadRevision();
+		APIModel model = headRevision.fetchRemote();
+		
+		System.out.println("Selected branch " + branch.getName());
+		
+		System.out.println("Collecting UUIDs...");
+		if (!tracker.isLibraryTracked()) {
+			tracker.trackLibraryUUIDs(getLibraryResources());
 		}
+		
+		tracker.clear();
+		List<Resource> inputResources = getInputResources();
+		//UUIDS coming from resources that were added later in time will shadow previous ones
+		tracker.trackLocalUUIDs(inputResources);
+		
+		EMFModelRefresher fetcher = new EMFModelRefresher(model, tracker);
+		
+		System.out.println("Downloading model...");
+		EMFModelDelta delta = fetcher.create();
+		
+		System.out.println("Adding model to index");
+		delta.getProjectRoots().forEach((eObject, dto) -> {
+			next(SYSMLX_EXTENSION);
+			Resource xmiResource = getResource();
+			if (eObject instanceof Namespace) {
+				xmiResource.getContents().add(eObject);
+			} else {
+				Namespace root = SysMLFactory.eINSTANCE.createNamespace();
+				NamespaceUtil.addOwnedMemberTo(root, (Element) eObject);
+				xmiResource.getContents().add(root);
+			}
+			addResourceToIndex(xmiResource);
+		});
+		
+		return "Project loaded: " + remoteProject.getProjectName() + ", " + remoteProject.getRemoteId().toString();
 	}
 
 	protected String download(String name) {
 		return "-h".equals(name)?
-				loadByName(null, Collections.singletonList("true")):
-				loadByName(name, Collections.emptyList());
+				loadByName(null, null, Collections.singletonList("true")):
+				loadByName(name, null, Collections.emptyList());
 	}
 
 	public String listPublications(List<String> help) {
@@ -535,9 +553,9 @@ public String listPublications(List<String> help) {
 				.collect(Collectors.joining("\n"));
 	}
 
-	protected ApiElementProcessingFacade getApiElementProcessingFacade(String modelName) {
+	protected ApiElementProcessingFacade getApiElementProcessingFacade(String modelName, String branchName) {
 		System.out.println("API base path: " + this.apiBasePath);
-		ApiElementProcessingFacade processingFacade = new ApiElementProcessingFacade(modelName, this.apiBasePath);	
+		ApiElementProcessingFacade processingFacade = new ApiElementProcessingFacade(modelName, branchName, this.apiBasePath);	
 		processingFacade.setIsIncludeDerived(true);
 		processingFacade.setTraversal(new Traversal(processingFacade));
 		return processingFacade;

org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractive.java

@@ -35,6 +35,7 @@ public class Load {
     		.keyword("id")
     		.keyword("name")
     		.optional("name")
+    		.keyword("branch")
             .flag("help", 'h', "true")
     		.build();
 
@@ -44,13 +45,15 @@ public static String load(List<String> args) {
         List<String> help = vals.get("help");
         List<String> name = vals.get("name");
         List<String> id = vals.get("id");
+        List<String> branches = vals.get("branch");
+        String branch = branches.isEmpty()? null: branches.get(0);
 
         if (!name.isEmpty() && !id.isEmpty()) {
         	return "Name and id cannot be provided at the same time.";
         } else if (!name.isEmpty()) {
-        	return ISysML.getKernelInstance().getInteractive().loadByName(name.get(0), help);
+        	return ISysML.getKernelInstance().getInteractive().loadByName(name.get(0), branch, help);
         } else if (!id.isEmpty()) {
-        	return ISysML.getKernelInstance().getInteractive().loadById(id.get(0), help);
+        	return ISysML.getKernelInstance().getInteractive().loadById(id.get(0), branch, help);
         } else {
         	return ISysML.getKernelInstance().getInteractive().help("%load");
         }