[Feature] [#4] Automated GitHub features (#6)

pylapp · web-flow · commit 8ebfa6e8053f · 2021-05-06T10:11:41.000+02:00
* fix: #4 - lost debug instructions Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com> * chore: #4 - download of temporary repositories, better logs Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com> * feat: project - ignore for Git files in data directories Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com> * chore: #4 - better debug logs Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com> * chore: #4 - better debug logs, and less typos Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ Toolbox is mainly written in Shell because this language is very efficient for f
 ## Environment
 
 You must have a _BASH_ ready environment and also _Ruby_.
-For example, _Bash_ version here is _3.2.5_7.
+For example, _Bash_ version here is _3.2.5_.
 
 ## Project tree
 
@@ -225,8 +225,8 @@ bash GitHubWizard.sh get-projects-conformity
 ```
 SSH will be used to clone repositories, thus you must have your SSH configuration ready:
 
-1 - Create an SSH key on your GitHub account [settings](https://github.com/settings/keys)
-2 - Add the SSH key in your environment
+1. Create an SSH key on your GitHub account [settings](https://github.com/settings/keys)
+2. Add the SSH key in your environment
 
 ```shell
 ssh-add .ssh/id_rsa
@@ -240,8 +240,8 @@ bash GitHubWizard.sh get-empty-projects
 ```
 SSH will be used to clone repositories, thus you must have your SSH configuration ready:
 
-1 - Create an SSH key on your GitHub account [settings](https://github.com/settings/keys)
-2 - Add the SSH key in your environment
+1. Create an SSH key on your GitHub account [settings](https://github.com/settings/keys)
+2. Add the SSH key in your environment
 
 ```shell
 ssh-add .ssh/id_rsa
diff --git a/toolbox/github/.gitignore b/toolbox/github/.gitignore
@@ -0,0 +1,3 @@
+# Debug and test purposes only
+toolbox/diver/data/
+toolbox/github/data/
diff --git a/toolbox/github/GitHubFacade.rb b/toolbox/github/GitHubFacade.rb
@@ -86,10 +86,12 @@
     Log.log "Getting members of organizations with 2FA disabled..."
     raw_members = GitHubWrapper.get_organization_members_with_2fa_disabled
     Log.debug "Found #{raw_members.length} members!"
+    cpt = 1
     raw_members.each { |light_member| 
-    Log.debug "Getting more details for #{light_member.login}"
+        Log.debug "Getting more details for #{light_member.login} (#{cpt} / #{raw_members.length})"
         member = GitHubWrapper.get_user(client, light_member.login)
         members << member
+        cpt += 1
     }
     Log.debug "Writting in log file #{$FILENAME_MEMBERS_2FA_DISABLED}..."
     FileManager.write_members_in_permanent_file(members, $FILENAME_MEMBERS_2FA_DISABLED)
@@ -108,10 +110,12 @@
     Log.log "Getting all members of organization..."
     raw_members = GitHubWrapper.get_all_organization_members
     Log.debug "Found #{raw_members.length} members!"
+    cpt = 1
     raw_members.each { |light_member| 
-        Log.debug "Getting more details for #{light_member.login}"
+        Log.debug "Getting more details for #{light_member.login} (#{cpt} / #{raw_members.length})"
         member = GitHubWrapper.get_user(client, light_member.login)
         members << member
+        cpt += 1
     }
     Log.debug "Writting in log file #{$FILENAME_MEMBERS}..."
     FileManager.write_members_in_permanent_file(members, $FILENAME_MEMBERS)
@@ -127,17 +131,20 @@
         exit $EXIT_BAD_SETUP
     end
     members = []
-    puts "Getting members of organization without company..."
+    Log.log "Getting members of organization without company..."
     raw_members = GitHubWrapper.get_all_organization_members
+    Log.debug "Found #{raw_members.length} members in organization."
+    cpt = 1
     raw_members.each { |light_member| 
-        Log.debug "Checking company for #{light_member.login}"
+        Log.debug "Checking company for #{light_member.login} (#{cpt} / #{raw_members.length})"
         member = GitHubWrapper.get_user(client, light_member.login)
         company = "#{member.company}"
         unless company.length > 0
             members << member
         end
+        cpt += 1
     }
-    Log.debug "Found #{members.length} members!"
+    Log.debug "Found #{members.length} members without defined company!"
     Log.debug "Writting in log file #{$FILENAME_MEMBERS_UNDEFINED_COMPANY}..."
     FileManager.write_members_in_permanent_file(members, $FILENAME_MEMBERS_UNDEFINED_COMPANY)
     Log.log "Task completed! Exits now."
diff --git a/toolbox/github/GitHubWrapper.rb b/toolbox/github/GitHubWrapper.rb
@@ -306,8 +306,6 @@ def self.get_projects_without_team(octokit_client, organization_name)
         repositories_without_team = []
         index = 1
         all_repositories.each { |repo|
-            puts repo.owner.login
-            exit
             Log.debug "Checking for repository '%s' (%s / %s)" % [repo.name, index, count]
             index += 1
             teams_url = repo.teams_url
@@ -443,18 +441,19 @@ def self.get_not_conform_repositories(octokit_client, organization_name)
             repository_ssh_url = repository.ssh_url
             current_repo = {"name" => "#{repository_name}", "url" => "#{repository_url}"}
             Log.debug "Will clone repository %s out of %s" % [cpt, repositories_count]
-            GitWrapper.clone_git_repository(repository_ssh_url, repository_name)
-            Log.debug "Checking content of #{repository_name}"
+            full_name="data/#{repository_name}"
+            GitWrapper.clone_git_repository(repository_ssh_url, full_name)
+            Log.debug "Checking content of '#{repository_name}' in folder '#{full_name}'"
             expected_files_name.each do |expected_file_name|
-                path_name = "#{repository_name}/#{expected_file_name}"
+                path_name = "#{full_name}/#{expected_file_name}"
                 if !File.exist?(path_name) && !File.exist?("#{path_name}.txt") && !File.exist?("#{path_name}.md")
                     current_repo[expected_file_name] = "0"
                 else
                     current_repo[expected_file_name] = "1"
                 end
             end
             unconform_repositories << current_repo
-            FileUtils.rm_rf(repository_name)
+            FileUtils.rm_rf(full_name)
             cpt += 1
         end
         return unconform_repositories
@@ -484,13 +483,14 @@ def self.get_empty_repositories(octokit_client, organization_name, limit = 1)
             repository_url = repository.html_url
             repository_ssh_url = repository.ssh_url
             Log.debug "Will clone repository %s out of %s" % [cpt, repositories_count]
-            GitWrapper.clone_git_repository(repository_ssh_url, repository_name)
-            Log.debug "Checking content of #{repository_name}"
-            count = Dir.glob(File.join(repository_name, '**', '*')).select { |file| File.file?(file) }.count
+            full_name="data/#{repository_name}"
+            GitWrapper.clone_git_repository(repository_ssh_url, full_name)
+            Log.debug "Checking content of '#{repository_name}' in foler '#{full_name}'"
+            count = Dir.glob(File.join(full_name, '**', '*')).select { |file| File.file?(file) }.count
             if count <= limit
                 empty_repositories << {"name" => "#{repository_name}", "url" => "#{repository_url}"}
             end
-            FileUtils.rm_rf(repository_name)
+            FileUtils.rm_rf(full_name)
             cpt += 1
         end
         return empty_repositories
diff --git a/toolbox/github/GitWrapper.rb b/toolbox/github/GitWrapper.rb
@@ -32,7 +32,7 @@ def self.clone_git_repository(ssh_url, folder_name)
         if folder_name.nil? || folder_name.empty?
             Log.error "Forlder for repository cloning is not defined, clone won't be done. Returns now." 
             return
-         end
+        end
         Log.log "Clone Git repository using SSH URL '%s' under name '%s'" % [ssh_url, folder_name]
         Git.clone(ssh_url, folder_name)
     end

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Debug and test purposes only`
	`2`	`+toolbox/diver/data/`
	`3`	`+toolbox/github/data/`