shiny java package example #6

marekhorst · 2016-02-16T20:23:45Z

Forgot to create PR for shiny package example.

You should find shiny package installation details in readme file.

…nt scripts

Issue #2 Before introducing the changes, the `make check` command failed due to an error and warnings. Introduced changes: - `@export` was moved because in the original position (at the bottom of the comment block) it was invisible to roxygen for some reason. - The comments inside body of the functions starting with `#'` were interpreted by roxygen. Changed that to `##`.

Issue #2 If the new RoxygenNote field is not present, the DESCRIPTION file gets regenerated when documentation is generated (`make docs`). This removes all the comments in the file.

Issue #2 `make clean build` command didn't work with the previous for of the Makefile.

Issue #2

Closes #2

Closes #4 This should prevent problems with old jars left in this directory after the version of the dependency in a subproject is changed.

…topts support to handle named input arguments

removing leading '.' causing troubles changing R package installation command

improving scripts by handling missing parameters properly adding eclipse .project resource to ingnored files

mkobos · 2016-02-17T08:20:25Z

README.markdown

+`./scripts/build/artifactory.sh`
+
+in root project directory. It creates both package and `latest.txt` files to be uploaded to artifactory.
+`latest.txt` file contains name of the current module and its main purpose is to serve as pointer to the latest module version in artifactory.


Shouldn't you write "package" instead of "module"?

mkobos · 2016-02-17T15:50:18Z

scripts/deployment/artifactory.sh

@@ -0,0 +1,81 @@
+#!/bin/bash
+# To be executed from the root project directory.
+# Obtains R package from remote artifactory and executes local.sh script with package downloaded to temporary directory.


I would remove all references to Artifactory in this code (comments, variable names etc.) since the code is more generic - it just retrieves files accessible through HTTP protocol. It doesn't matter if it's Artifactory or some other HTTP-supporting service. I would use a description like "repository" or "artifact repo" or something like this.

I went with "repository".

mkobos · 2016-02-18T13:48:46Z

I analyzed the dependencies of the build and deploy scripts and here are some general reflections.

The deployment-related scripts should be separate from R package's code (and probably placed in a separate source code project) because they don't need much knowledge about the package itself, details follow below.

Scripts to upload the built package to the artifacts repository. These scripts should be only interested in taking a certain file and putting it in artifacts repository (from the scripts' POV, it doesn't matter what the file contains). Note that taking into consideration the way we currently use Artifactory and limitations that it forces upon us (e.g., we're not able to list files in given directory), it would be easier to simply treat a certain shared NFS directory as the repository. Functionalities of the scripts follow.
1. Uploading the package. In the current approach, this would mean taking a .tar.gz package, generating latest.txt file for it and uploading it to Artifact. Note that the functionality uploading the package to Artifactory is not needed by Jenkins machine because it has it implemented already.
2. Downloading the package. This is something that deployment/artifactory.sh script does if you skip one of the last lines that calls deployment/local.sh script.
3. Listing available packages. This is not implemented. It's a nice-to-have feature but not really essential as for now. Apparently this functionality is not easy to implement when you're using Artifactory as the artifacts repository. It would be easy to do if you used a shared NFS directory.
Scripts for deploying package. These scripts are only interested in taking a local R package file with shiny app inside and deploying it in a Shiny server. The package itself can be any R package as long as it follows a convention that things to be copied to Shiny server's directory are inside of shiny directory of the package. Functionalities of the scripts follow.
1. Deploy package accessible locally in local Shiny server. This is something that deployment/local.sh script does currently if you skip the part where latest.txt file is handled (because this functionality shouldn't know anything about that file because it's related to accessing artifacts repository and not deploying the application).
2. Deploy package accessible locally in remote Shiny server. I'm not sure if this functionality is currently needed.
Utility scripts that link scripts listed above to make developer's life easier. Functionalities of the scripts follow.
1. Deploy package from artifacts repository in local Shiny server. This downloads the package first and then deploys it in local Shiny server.
2. Deploy package from artifacts repository in remote Shiny server. This is not implemented now. I'm not sure if it's really needed. With this functionality in place it would be probably easier for the developer to deploy the application since he wouldn't have to log into the machine with the Shiny server to deploy the application.

Apart from the deployment-related scripts mentioned above, we have a functionality which is a part of package's build process of generating a file with a git hash. The file should be accessible from within the code of the application.

mkobos · 2016-02-18T13:57:54Z

I placed some high-level remarks in #6 (comment).

marekhorst · 2016-03-03T19:11:17Z

I've just pushed commits with all the fixes mentioned in comments.

As for the general reflections: we should discuss it at the next meeting.

mkobos · 2016-03-04T11:38:17Z

I've just pushed commits with all the fixes mentioned in comments.

As for the general reflections: we should discuss it at the next meeting.

As we talked in-person, the task of preparing the deployment code can wait because it became a rather low-priority one.

marekhorst and others added 14 commits February 5, 2016 18:35

introducing shiny app example and first version of build and deployme…

617a110

…nt scripts

improving build and deployment scripts

ce23a1f

Fix problem with overwriting DESCRIPTION file in Roxygen2 v.5.0

c2d8559

Issue #2 If the new RoxygenNote field is not present, the DESCRIPTION file gets regenerated when documentation is generated (`make docs`). This removes all the comments in the file.

Fix make clean build problem

5636a64

Issue #2 `make clean build` command didn't work with the previous for of the Makefile.

Describe problem with Java versions

25a88eb

Issue #2

Bump version

c65b606

Closes #2

Clean inst/java directory before building subprojects

e810a89

Closes #4 This should prevent problems with old jars left in this directory after the version of the dependency in a subproject is changed.

triggering cleaning task explicitly

e394410

setting some of the input arguments to default values, introducing ge…

d095868

…topts support to handle named input arguments

supporting artifactory password provided as input parameter

e51bfd7

fixing assignment and removing logging

34d0f89

tuning scripts to be runnable on remote machine

1a850da

removing leading '.' causing troubles changing R package installation command

describing scripts in README.markdown file

b5b0e77

improving scripts by handling missing parameters properly adding eclipse .project resource to ingnored files

marekhorst assigned mkobos Feb 16, 2016

mkobos reviewed Feb 17, 2016
View reviewed changes

mkobos assigned marekhorst and unassigned mkobos Feb 18, 2016

marekhorst added 2 commits March 3, 2016 19:54

Fixing all the issues mentioned in pull request comments.

9d17fb8

removing version.txt file after building package

aa3885b

marekhorst assigned mkobos and unassigned marekhorst Mar 4, 2016

mkobos assigned marekhorst and unassigned mkobos Mar 4, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

shiny java package example #6

shiny java package example #6

marekhorst commented Feb 16, 2016

mkobos Feb 17, 2016

marekhorst Mar 3, 2016

mkobos Mar 4, 2016

mkobos Feb 17, 2016

marekhorst Mar 3, 2016

mkobos Mar 4, 2016

mkobos commented Feb 18, 2016

mkobos commented Feb 18, 2016

marekhorst commented Mar 3, 2016

mkobos commented Mar 4, 2016

shiny java package example #6

Are you sure you want to change the base?

shiny java package example #6

Conversation

marekhorst commented Feb 16, 2016

mkobos Feb 17, 2016

Choose a reason for hiding this comment

marekhorst Mar 3, 2016

Choose a reason for hiding this comment

mkobos Mar 4, 2016

Choose a reason for hiding this comment

mkobos Feb 17, 2016

Choose a reason for hiding this comment

marekhorst Mar 3, 2016

Choose a reason for hiding this comment

mkobos Mar 4, 2016

Choose a reason for hiding this comment

mkobos commented Feb 18, 2016

mkobos commented Feb 18, 2016

marekhorst commented Mar 3, 2016

mkobos commented Mar 4, 2016